summaryrefslogtreecommitdiffstats
path: root/toolkit/components/nimbus/FeatureManifest.yaml
blob: 746ac4738d59032d0deabebbe7522c53131f87ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
# 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:
        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: barret@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: barret@mozilla.com
  isEarlyStartup: true
  hasExposure: false
  variables:
    value:
      type: string
      setPref:
        branch: user
        pref: 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.
    richSuggestionsFeatureGate:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.richSuggestions.featureGate
      description: >-
        Feature gate that controls whether Rich Suggestions are enabled.
    serpEventTelemetryEnabled:
      type: boolean
      setPref:
        branch: default
        pref: browser.search.serpEventTelemetry.enabled
      description: Whether the Glean SERP event telemetry is enabled.
    serpEventTelemetryCategorizationEnabled:
      type: boolean
      setPref:
        branch: default
        pref: browser.search.serpEventTelemetryCategorization.enabled
      description: Whether the Glean SERP event telemetry for SERP categorization is enabled.
    trendingEnabled:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.trending.featureGate
      description: Feature gate that controls whether trending suggestions are enabled.
    trendingRequireSearchMode:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.trending.requireSearchMode
      description: Controls whether trending suggestions are only shown in search mode or not.
    trendingMaxResultsNoSearchMode:
      type: int
      setPref:
        branch: default
        pref: browser.urlbar.trending.maxResultsNoSearchMode
      description: The maximum number of trending results mode outside search mode.

# `searchConfiguration` is for search experiment features for items that require
# isEarlyStartup to be true. These items may require a reload of the search
# engine configuration, and an additional reload may happen during the startup
# process.
searchConfiguration:
  description: Search experimentation support for the engine configuration
  owner: search-and-suggest-program@mozilla.com
  isEarlyStartup: true
  hasExposure: false
  variables:
    experiment:
      type: string
      fallbackPref: browser.search.experiment
      description: >-
        Used to activate only matching configurations that contain the value in
        `experiment`
    seperatePrivateDefaultUIEnabled:
      type: boolean
      description: Whether the UI for the separate private default feature is enabled.
    seperatePrivateDefaultUrlbarResultEnabled:
      type: boolean
      description: Whether the urlbar result for the separate private default is shown.

urlbar:
  description: The Address Bar
  owner: search-and-suggest-program@mozilla.com
  hasExposure: true
  exposureDescription: >-
    The timing of the exposure event depends on the experiment, but generally
    the event is recorded once per app session when the user first encounters
    the UI of the experiment in which they're enrolled.
  variables:
    addonsFeatureGate:
      type: boolean
      fallbackPref: browser.urlbar.addons.featureGate
      description: >-
        Feature gate that controls whether all aspects of the addons suggestion
        feature are exposed to the user.
    addonsShowLessFrequentlyCap:
      type: int
      description: >-
        If defined and non-zero, this is the maximum number of times the user
        will be able to click the "Show less frequently" command for addon
        suggestions. If undefined or zero, the user will be able to click the
        command without any limit.
    autoFillAdaptiveHistoryEnabled:
      type: boolean
      fallbackPref: browser.urlbar.autoFill.adaptiveHistory.enabled
      description: Whether enabling adaptive history autofill.
    autoFillAdaptiveHistoryMinCharsThreshold:
      type: int
      fallbackPref: browser.urlbar.autoFill.adaptiveHistory.minCharsThreshold
      description: Minimum char length of the user's search string to trigger adaptive history autofill.
    autoFillAdaptiveHistoryUseCountThreshold:
      type: string
      description: This value assumes float expression like "0.47". Threshold for use count of input history that we handle as adaptive history autofill. If the use count is this value or more, it will be a candidate.
    experimentType:
      type: string
      description: The type of the experiment (or rollout). If "best-match", then the Nimbus exposure event will be recorded when the user first triggers a best match (or would have triggered a best match, for users in the control group). If empty, the event will be recorded when the user first triggers any type of Suggest suggestion.
      enum:
        - best-match
        - ""
    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:
        branch: default
        pref: 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:
        branch: default
        pref: 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.
    pocketFeatureGate:
      type: boolean
      fallbackPref: browser.urlbar.pocket.featureGate
      description: >-
        Feature gate that controls whether all aspects of the Pocket suggestions
        feature are exposed to the user.
    pocketShowLessFrequentlyCap:
      type: int
      description: >-
        If defined and non-zero, this is the maximum number of times the user
        will be able to click the "Show less frequently" command for Pocket
        suggestions. If undefined or zero, the user will be able to click the
        command without any limit.
    quickSuggestAllowPositionInSuggestions:
      type: boolean
      fallbackPref: browser.urlbar.quicksuggest.allowPositionInSuggestions
      description: Whether quick suggest results can be shown in position specified in the suggestions.
    quickSuggestContextualOptInEnabled:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.quicksuggest.contextualOptIn
      description: Whether the Firefox Suggest contextual opt-in result is enabled. If true, this implicitly disables shouldShowOnboardingDialog.
    quickSuggestContextualOptInSayHello:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.quicksuggest.contextualOptIn.sayHello
      description: Controls which variant of the copy is used for the Firefox Suggest contextual opt-in result.
    quickSuggestContextualOptInTopPosition:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.quicksuggest.contextualOptIn.topPosition
      description: Controls whether the Firefox Suggest contextual opt-in result appears at the top of results or at the bottom, after one-off buttons.
    quickSuggestDataCollectionEnabled:
      type: boolean
      description: Whether data collection should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) data collection, if the user has already toggled that preference.
    quickSuggestEnabled:
      type: boolean
      fallbackPref: browser.urlbar.quicksuggest.enabled
      description: Gate for the Firefox Suggest feature as a whole. If false, the Firefox Suggest preferences UI and Suggest suggestions will not be shown. If true, the preferences UI will be shown, and the user can turn suggestions on or off.
    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.
    quickSuggestRustEnabled:
      type: boolean
      fallbackPref: browser.urlbar.quicksuggest.rustEnabled
      description: >-
        Whether Firefox Suggest will use the new Rust backend instead of the
        original JS backend.
    quickSuggestScenario:
      # IMPORTANT: This should not have a fallbackPref. See UrlbarPrefs.jsm.
      type: string
      description: The Firefox Suggest scenario in which the user is enrolled
      enum:
        - history
        - offline
        - online
    quickSuggestScoreMap:
      type: json
      description: >-
        A JSON object that maps telemetry result types to suggestion scores. If
        a telemetry result type is present in this map, the client will use the
        corresponding score as the score for all suggestions of the type,
        overriding all other sources of scores for the type. In other words,
        the scores in this map will override scores that are set in remote
        settings and Merino as well as scores that are hardcoded in the client.
        Example entries: `"amo": 0.5`, `"adm_sponsored": 0.9`
    quickSuggestShouldShowOnboardingDialog:
      type: boolean
      fallbackPref: browser.urlbar.quicksuggest.shouldShowOnboardingDialog
      description: Whether or not to show the QuickSuggest onboarding dialog
    quickSuggestShowOnboardingDialogAfterNRestarts:
      type: int
      fallbackPref: browser.urlbar.quicksuggest.showOnboardingDialogAfterNRestarts
      description: Show QuickSuggest onboarding dialog after N browser restarts
    quickSuggestSponsoredEnabled:
      type: boolean
      description: Whether sponsored suggestions should be enabled by default. If this variable is specified, it will override the value implied by the scenario. It will never override the user's local preference to disable (or enable) sponsored suggestions, if the user has already toggled that preference.
    quickSuggestSponsoredIndex:
      type: int
      fallbackPref: browser.urlbar.quicksuggest.sponsoredIndex
      description: >-
        The index of sponsored QuickSuggest results within the general group. A
        negative index is relative to the end of the group
    quickSuggestSponsoredPriority:
      type: boolean
      fallbackPref: browser.urlbar.quicksuggest.sponsoredPriority
      description: >-
        Whether or not showing sponsored suggestion as priority.
        If this variable is true, the following things are processed.
        * "Sponsored" label is shown as the group label.
        * Change the suggested index to 1.
        * Handle as top pick.
    recentSearchesFeatureGate:
      type: boolean
      setPref:
        branch: default
        pref: browser.urlbar.recentsearches.featureGate
      description: Gate for the recent searches feature.
    recentSearchesMaxResults:
      type: int
      setPref:
        branch: default
        pref: browser.urlbar.recentsearches.maxResults
      description: The maximum number of recent searches to show.
    recordNavigationalSuggestionTelemetry:
      type: boolean
      description: Whether to record navigational suggestion telemetry. Defaults to false.
    showSearchTermsFeatureGate:
      type: boolean
      fallbackPref: browser.urlbar.showSearchTerms.featureGate
      description: Gate for the show search terms feature. If false, the preference#search will not show the search terms feature checkbox, and search terms will never persist in the urlbar. If true, the preference checkbox will be shown on preferences#search, and the user can choose to persist search terms on or off in the urlbar.
    weatherFeatureGate:
      type: boolean
      fallbackPref: browser.urlbar.weather.featureGate
      description: >-
        Feature gate that controls whether all aspects of the weather suggestion
        feature are exposed to the user. 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.
    yelpMinKeywordLength:
      type: int
      fallbackPref: browser.urlbar.yelp.minKeywordLength
      description: >-
        If the length of user's query is less than this value plus
        "yelp.showLessFrequentlyCount", Yelp suggestion never be shown.
    yelpFeatureGate:
      type: boolean
      fallbackPref: browser.urlbar.yelp.featureGate
      description: >-
        Feature gate that controls whether all aspects of the Yelp suggestion
        feature are exposed to the user.
    yelpShowLessFrequentlyCap:
      type: int
      fallbackPref: browser.urlbar.yelp.showLessFrequentlyCap
      description: >-
        If defined and non-zero, this is the maximum number of times the user
        will be able to click the "Show less frequently" command for Yelp
        suggestions. If undefined or zero, the user will be able to click the
        command without any limit.
    yelpSuggestNonPriorityIndex:
      type: int
      fallbackPref: browser.urlbar.yelp.suggestedIndex
      description: >-
        The group-relative suggestedIndex of Yelp suggestions within the Firefox
        Suggest section. Ignored when `yelpSuggestPriority` is true.
    yelpSuggestPriority:
      type: boolean
      fallbackPref: browser.urlbar.yelp.priority
      description: >-
        Whether or not showing yelp suggestion as priority.
        If this variable is true, the following things are processed.
        * Change the suggested index to 1.
        * Handle as top pick.
    originsAlternativeEnable:
      description: >-
        Use an alternative ranking algorithm for autofilling origins, that is
        mainly domains of Web pages. When the user types the beginning of an
        origin, we autofill the whole origin. Whether autofill happens depends
        on the ranking algorithm. Bookmarks are always autofilled anyway.
      type: boolean
      setPref:
        branch: user
        pref: "places.frecency.origins.alternative.featureGate"
    originsDaysCutOff:
      description: >-
        The alternative ranking algorithm only considers pages visited in the
        last N days, where N is controlled by this variable.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.origins.alternative.daysCutOff"
    pagesAlternativeEnable:
      description: >-
        Use an alternative ranking algorithm for sorting history and bookmarks
        among the urlbar results.
      type: boolean
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.featureGate"
    pagesNumSampledVisits:
      description: >-
        The number of recent visits to sample when calculating the ranking of
        a page. Examining all the visits would be expensive, so we only sample
        recent visits.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.numSampledVisits"
    pagesHalfLifeDays:
      description: >-
        The number of days after which the ranking halves. This implements the
        "recency" part of the algorithm.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.halfLifeDays"
    pagesHighWeight:
      description: >-
        The weight to use for the high importance bucket.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.highWeight"
    pagesMediumWeight:
      description: >-
        The weight to use for the medium importance bucket.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.mediumWeight"
    pagesLowWeight:
      description: >-
        The weight to use for the low importance bucket.
      type: int
      setPref:
        branch: user
        pref: "places.frecency.pages.alternative.lowWeight"

aboutwelcome:
  description: "The about:welcome page"
  owner: omc@mozilla.com
  hasExposure: true
  exposureDescription: >-
    Exposure is sent once per browsing session when the about:welcome URL is
    first accessed.
  isEarlyStartup: true
  variables:
    enabled:
      type: boolean
      fallbackPref: browser.aboutwelcome.enabled
      description: >-
        Should users see about:welcome? If this is false, users will see a
        regular new tab instead.
    id:
      type: string
      description: >-
        Descriptive ID for the about:welcome content
    screens:
      type: json
      fallbackPref: browser.aboutwelcome.screens
      description: Content to show in the onboarding flow
    languageMismatchEnabled:
      type: boolean
      fallbackPref: intl.multilingual.aboutWelcome.languageMismatchEnabled
      description: >-
        Suggest to change the language on about:welcome when there is a mismatch with
        the OS.
    transitions:
      type: boolean
      description: Enable transition effect between screens
    showModal:
      type: boolean
      fallbackPref: browser.aboutwelcome.showModal
      description: >-
        Should users see window modal onboarding
    backdrop:
      type: string
      fallbackPref: browser.aboutwelcome.backdrop
      description: >-
        Specify the color to be used to update the background color
    newtabUrlBarFocus:
      type: boolean
      fallbackPref: browser.aboutwelcome.newtabUrlBarFocus
      description: >-
        Should the urlbar be focused when the new tab page loads after new user onboarding

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.

windowsJumpList:
  description: "Controls for the Windows Jump List integration."
  owner: mconley@mozilla.com
  hasExposure: false
  isEarlyStartup: true
  variables:
    legacyBackend:
      type: boolean
      setPref:
        branch: user
        pref: browser.taskbar.lists.legacyBackend
      description: True if users should use the legacy Windows Jump List backend.

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
    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.
    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:
        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 veriant 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
    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:
    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?

cm-csv-import:
  description: Importing logins from CSV files
  owner: issozi@mozilla.com
  hasExposure: false
  variables:
    csvImport:
      type: boolean
      description: Can show CSV Import in about:logins or Migration Wizard
      setPref:
        branch: default
        pref: "signon.management.page.fileImport.enabled"

# This feature flag mirrors the one used for ios
# https://github.com/mozilla-mobile/firefox-ios/blob/main/nimbus-features/addressAutofillFeature.yaml
address-autofill-feature:
  description: Enabling address autofill feature
  owner: issozi@mozilla.com
  hasExposure: false
  variables:
    status:
      type: boolean
      setPref:
        branch: default
        pref: extensions.formautofill.addresses.experiments.enabled
      description: If true, we will allow user to use address autofill

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?

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
  isEarlyStartup: true
  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
  isEarlyStartup: true
  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

pdfjs:
  description: The Firefox pdf reader.
  owner: pdfjs-team@mozilla.com
  hasExposure: true
  exposureDescription: >-
    Exposure is sent each time a pdf is displayed.
  variables:
    addHighlight:
      description: Set to true to highlight some text or something else in an existing pdf.
      type: boolean
      setPref:
        branch: default
        pref: pdfjs.enableHighlightEditor

addAnImageInPDF:
  description: Add an image in an existing pdf.
  owner: cdenizet@mozilla.com
  hasExposure: false
  variables:
    boolean:
      description: Set to true to enable the add-an-image feature
      type: boolean
      setPref:
        branch: default
        pref: pdfjs.enableStampEditor

# 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: {}

pbNewtab:
  description: "A Firefox Messaging System message for the pbNewtab message channel"
  owner: omc@mozilla.com
  hasExposure: true
  exposureDescription: >-
    Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched.
  schema:
    uri: "chrome://browser/content/asrouter/schemas/MessagingExperiment.schema.json"
    path: "browser/components/asrouter/content-src/schemas/MessagingExperiment.schema.json"
  variables: {}

backgroundTaskMessage:
  description: "A Firefox Messaging System message for the background task message channel"
  owner: nalexander@mozilla.com
  applications:
    - firefox-desktop-background-task
  hasExposure: true
  exposureDescription: >-
    Exposure is sent if the message is about to be shown after trigger and targeting conditions on the message matched.
  schema:
    uri: "chrome://browser/content/asrouter/schemas/BackgroundTaskMessagingExperiment.schema.json"
    path: "browser/components/asrouter/content-src/schemas/BackgroundTaskMessagingExperiment.schema.json"
  variables: {}

backgroundUpdateAutomaticRestart:
  description: "Whether to automatically restart when the background update task could make more progress."
  owner: nalexander@mozilla.com
  applications:
    - firefox-desktop-background-task
  hasExposure: false
  variables:
    enabled:
      type: boolean
      fallbackPref: app.update.background.automaticRestartEnabled
      description: >-
        When true, make the background update task restart when the final update state is `READY_FOR_RESTART`.
        Generally, this will finish applying a staged update, completing the update earlier than it
        otherwise would have been completed.

pictureinpicture:
  description: Message for first time Picture-in-Picture users
  owner: nbaumgardner@mozilla.com
  hasExposure: true
  exposureDescription: Exposure is sent when a user hovers over a video and Picture-in-Picture has not been used before
  variables:
    title:
      type: string
      description: The title to be used for the PiP toggle
    message:
      type: string
      description: The message to be used in the PiP toggle
    showIconOnly:
      type: boolean
      description: Whether to show the first time PiP toggle or show the PiP icon only
    oldToggle:
      type: boolean
      description: Whether to show the control style (true) or variant style (false) for the first time PiP toggle
    displayDuration:
      type: int
      description: Duration of PiP first time toggle display in days before switching to PiP icon toggle

glean:
  description: "The Glean data-control-plane feature within Firefox Desktop for controlling metric configuration"
  owner: glean-team@mozilla.com
  hasExposure: false
  variables:
    newtabPingEnabled:
      type: "boolean"
      fallbackPref: "browser.newtabpage.ping.enabled"
      description: "Whether to submit the 'newtab' ping"
    gleanMetricConfiguration:
      type: json
      description: |
        A map of metric base-identifiers to booleans representing the state of the 'enabled' flag for that metric.
        This variable is intended for interacting with the Glean data-control-plane via the Server Knobs functionality
        to remotely configure metrics to be enabled or disabled.

gleanInternalSdk:
  description: "The Glean internal SDK feature intended only for internal Glean Team use"
  hasExposure: false
  # Some variables are used through the C++ API and thus require pref-storage.
  # We rely on those values at Glean.init time, which happens at startup.
  isEarlyStartup: true
  variables:
    finalInactive:
      type: "boolean"
      description: "Enables FOG early shutdown pings when true"
    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
    enableEventTimestamps:
      type: "boolean"
      description: "Enables precise event timestamps for Glean events"

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."
    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"
    onboarding:
      type: boolean
      fallbackPref: "browser.majorrelease.onboarding"
      description: "Whether or not to use the MR2022 onboarding settings."

browserLowMemoryPrefs:
  description: Prefs which control the browser's behaviour under low memory.
  owner: haftandilian@mozilla.com
  hasExposure: false
  variables:
    lowMemoryResponseMask:
      description: Control the response on macOS when under memory pressure.
      type: int
      setPref:
        branch: default
        pref: "browser.lowMemoryResponseMask"
    lowMemoryResponseOnWarn:
      description: Controls which macOS memory-pressure levels trigger the browser low memory response.
      type: boolean
      setPref:
        branch: default
        pref: "browser.lowMemoryResponseOnWarn"
    tabsUnloadOnLowMemory:
      description: Whether to unload tabs when available memory is running low.
      type: boolean
      setPref:
        branch: default
        pref: "browser.tabs.unloadOnLowMemory"

scriptLoaderPrefs:
  description: Prefs that control the script loader.
  owner: npierron@mozilla.com
  hasExposure: false
  variables:
    delazificationStrategy:
      description: >-
        Selects which parsing/delazification strategy should be used while
        parsing scripts off-main-thread. See DelazificationOption in
        CompileOptions.h for values.
      type: int
      setPref:
        branch: default
        pref: "dom.script_loader.delazification.strategy"

echPrefs:
  description: Prefs that control Encrypted Client Hello.
  owner: djackson@mozilla.com
  hasExposure: false
  variables:
    tlsEnabled:
      description: Whether to enable ECH for connections using TLS
      type: boolean
      setPref:
        branch: default
        pref: "network.dns.echconfig.enabled"
    h3Enabled:
      description: Whether to enable ECH for connections using H3/QUIC
      type: boolean
      setPref:
        branch: default
        pref: "network.dns.http3_echconfig.enabled"
    forceWaitHttpsRR:
      description: Whether to force waiting for HTTPS DNS records, which ECH requires.
      type: boolean
      setPref:
        branch: default
        pref: "network.dns.force_waiting_https_rr"
    insecureFallback:
      description: Whether to fallback to non-ECH connections if all ECH RRs fail.
      type: boolean
      setPref:
        branch: default
        pref: "network.dns.echconfig.fallback_to_origin_when_all_failed"
    tlsGreaseProb:
      description: Probability of GREASEing a TLS connection with ECH (0-100).
      type: int
      setPref:
        branch: default
        pref: "security.tls.ech.grease_probability"
    h3GreaseEnabled:
      description: Whether to apply GREASE settings to H3/QUIC connections.
      type: boolean
      setPref:
        branch: default
        pref: "security.tls.ech.grease_http3"
    disableGreaseOnFallback:
      description: Whether to disable GREASE when retrying a connection.
      type: boolean
      setPref:
        branch: default
        pref: "security.tls.ech.disable_grease_on_fallback"
    greasePaddingSize:
      description: Assumed echConfig padding length for GREASE extensions (1-255).
      type: int
      setPref:
        branch: default
        pref: "security.tls.ech.grease_size"

dohPrefs:
  description: Prefs that control DNS over HTTPS.
  owner: vgosu@mozilla.com
  hasExposure: false
  variables:
    trrMode:
      description: Has a value of 2 for TRR first, 3 for TRR only, 0 for off.
      type: int
      setPref:
        branch: default
        pref: "network.trr.mode"
    trrUri:
      description: The URL of the DNS over HTTPS endpoint
      type: string
      setPref:
        branch: default
        pref: "network.trr.uri"
    dohMode:
      description: Same as trrMode, but set by the DoHController module.
      type: int
      setPref:
        branch: default
        pref: "doh-rollout.mode"
    dohUri:
      description: Same as trrUri, but set by the DoHController module.
      type: string
      setPref:
        branch: default
        pref: "doh-rollout.uri"
    enableFallbackWarningPage:
      description: Whether DoH fallback warning page will be displayed when DoH doesn't work in TRR first mode.
      type: boolean
      setPref:
        branch: default
        pref: "network.trr.display_fallback_warning"
    showFallbackCheckbox:
      description: Whether the checkbox to enable the fallback warning page is displayed in the settings UI.
      type: boolean
      setPref:
        branch: default
        pref: "network.trr_ui.show_fallback_warning_option"

dooh:
  description: "DNS over Oblivious HTTP"
  owner: vgosu@mozilla.com
  hasExposure: false
  variables:
    ohttpEnabled:
      description: Whether to use Oblivious HTTP for the resolution
      type: boolean
      setPref:
        branch: default
        pref: "network.trr.use_ohttp"
    ohttpRelayUri:
      description: The URL of the Oblivious HTTP relay
      type: string
      setPref:
        branch: default
        pref: "network.trr.ohttp.relay_uri"
    ohttpConfigUri:
      description: The URL used to fetch the configuration of the Oblivious HTTP gateway
      type: string
      setPref:
        branch: default
        pref: "network.trr.ohttp.config_uri"
    ohttpUri:
      description: The URL of the Oblivious DNS over HTTPS target resource
      type: string
      setPref:
        branch: default
        pref: "network.trr.ohttp.uri"

networking:
  description: "Firefox Networking (Necko)"
  owner: vgosu@mozilla.com
  hasExposure: false
  variables:
    ehPreloadEnabled:
      description: Whether Early Hints preload is enabled
      type: boolean
      setPref:
        branch: default
        pref: "network.early-hints.enabled"
    ehPreconnectEnabled:
      description: Whether Early Hints preconnect is enabled
      type: boolean
      setPref:
        branch: default
        pref: "network.early-hints.preconnect.enabled"
    dnsMaxPriorityThreads:
      description: The maximum number of high priority DNS threads that can be created.
      type: int
      setPref:
        branch: default
        pref: "network.dns.max_high_priority_threads"
    dnsMaxAnyPriorityThreads:
      description: The maximum number of DNS threads that can be created to handle any priority DNS requests.
      type: int
      setPref:
        branch: default
        pref: "network.dns.max_any_priority_threads"
    preconnect:
      description: Whether the rel=preconnect feature is enabled
      type: boolean
      setPref:
        branch: default
        pref: "network.preconnect"
    networkPredictor:
      description: Whether the Necko predictor is enabled
      type: boolean
      setPref:
        branch: default
        pref: "network.predictor.enabled"
    http3CCalgorithm:
      description: The congestion control algorithm with which to configure neqo. 0 for NewReno, 1 for Cubic
      type: int
      setPref:
        branch: default
        pref: "network.http.http3.cc_algorithm"
    sendOnDataFinished:
      description: Whether we can send OnDataFinished in the content process
      type: boolean
      setPref:
        branch: default
        pref: "network.send_OnDataFinished"
    sendOnDataFinshedFromInputStreamPump:
      description: Whether we can send OnDataFinished to the content process from InputStreamPump
      type: boolean
      setPref:
        branch: default
        pref: "network.send_OnDataFinished.nsInputStreamPump"
    sendOnDataFinishedToHtml5parser:
      description: Whether we can send OnDataFinished to the html5parser in content process
      type: boolean
      setPref:
        branch: default
        pref: "network.send_OnDataFinished.html5parser"
    sendOnDataFinishedToCssLoader:
      description: Whether we can send OnDataFinished to the cssLoader in content process
      type: boolean
      setPref:
        branch: default
        pref: "network.send_OnDataFinished.cssLoader"

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 task 1.
    task1TaskId:
      type: string
      fallbackPref: toolkit.telemetry.dap_task1_taskid
      description: The task ID to use for task 1 measurements.
    visitCountingEnabled:
      type: boolean
      fallbackPref: toolkit.telemetry.dap_visit_counting_enabled
      description: Whether to count visits to the provided list of URLs.
    visitCountingExperimentList:
      fallbackPref: toolkit.telemetry.dap_visit_counting_experiment_list
      type: json
      description: A list of experiments with URLs for which we want to count visits.

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"

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:
        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

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:
        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.

migrationWizard:
  description: Prefs to control the Migration Wizard UI.
  owner: mconley@mozilla.com
  hasExposure: false
  isEarlyStartup: true
  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

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:
        branch: user
        pref: "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:
        branch: user
        pref: "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:
        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
  isEarlyStartup: true
  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"

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:
        branch: default
        pref: "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

shopping2023:
  description: Prefs to control the 2023 shopping experiment.
  owner: jhirsch@mozilla.com
  hasExposure: true
  exposureDescription: >-
    The timing of the exposure event depends on the experiment, but generally
    the event is recorded when the user first encounters onboarding UI for
    the shopping feature.
  variables:
    enabled:
      description: True if the experience is enabled (experimental treatment group)
      type: boolean
      fallbackPref: browser.shopping.experience2023.enabled
    control:
      description: True if the experiment is enabled but experience is disabled (experimental control group)
      type: boolean
      fallbackPref: browser.shopping.experience2023.control
    adsEnabled:
      description: True if showing recommended products is enabled
      type: boolean
      setPref:
        branch: default
        pref: browser.shopping.experience2023.ads.enabled
    adsExposure:
      description: True if we want to record ad inventory for opted-in users, even if ads are disabled
      type: boolean
      setPref:
        branch: default
        pref: browser.shopping.experience2023.ads.exposure
    surveyEnabled:
      description: True if showing survey is enabled
      type: boolean
      fallbackPref: browser.shopping.experience2023.survey.enabled
    autoOpenEnabled:
      description: True if auto-open behavior for the sidebar is enabled
      type: boolean
      setPref:
        branch: default
        pref: browser.shopping.experience2023.autoOpen.enabled

shoppingOHTTP:
  description: Prefs to control the OHTTP URLs used for shopping.
  owner: gijs@mozilla.com
  hasExposure: false
  variables:
    ohttpRelayURL:
      description: What OHTTP relay URL to use
      type: string
      setPref:
        branch: default
        pref: toolkit.shopping.ohttpRelayURL
    ohttpConfigURL:
      description: URL for the OHTTP config to use
      type: string
      setPref:
        branch: default
        pref: toolkit.shopping.ohttpConfigURL

opaqueResponseBlocking:
  description: Prefs to enable Opaque Response Blocking
  owner: farre@mozilla.com
  isEarlyStartup: true
  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.
  isEarlyStartup: true
  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
  isEarlyStartup: true
  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.
  isEarlyStartup: true
  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: default
        pref: app.update.background.allowUpdatesForUnelevatedInstallations

defaultAgent:
  description: >-
    Features that configure the Windows Default Browser Agent.
  owner: install-update@mozilla.com
  applications:
    - firefox-desktop-background-task
  hasExposure: false
  variables:
    cppFallback:
      description: >-
        Triggers the Default Agent to fall back to the C++ implementation of DoTask if true.
      type: boolean
      fallbackPref: "defaultAgent.cppFallback.enabled"

bookmarks:
  description: Prefs to control aspects of the bookmarks system.
  owner: omc@mozilla.com
  hasExposure: false
  isEarlyStartup: true
  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.

cookieBannerHandling:
  description: Automatically handle cookie banners on the user's behalf.
  owner: pbz@mozilla.com
  hasExposure: false
  variables:
    modeNormalBrowsing:
      type: int
      setPref:
        branch: default
        pref: cookiebanners.service.mode
      description: >-
        Controls the cookie banner handling mode in normal browsing.
        Values: 0 - disabled, 1 - reject all, 2 - reject all with accept all fallback.
    modePrivateBrowsing:
      type: int
      setPref:
        branch: default
        pref: cookiebanners.service.mode.privateBrowsing
      description: >-
        Controls the cookie banner handling mode in private browsing.
        Values: 0 - disabled, 1 - reject all, 2 - reject all with accept all fallback.
    enableGlobalRules:
      type: boolean
      setPref:
        branch: default
        pref: cookiebanners.service.enableGlobalRules
      description: >-
        Enables use of global CookieBannerRules, which apply to all sites.
        This enables handling of CMPs across sites without the use of site-specific rules.
    enableGlobalRulesSubFrames:
      type: boolean
      setPref:
        branch: default
        pref: cookiebanners.service.enableGlobalRules.subFrames
      description: >-
        Whether global rules are allowed to run in sub-frames. Running query
        selectors in every sub-frame may negatively impact performance, but is
        required for some CMPs.
    enableDetectOnly:
      type: boolean
      setPref:
        branch: default
        pref: cookiebanners.service.detectOnly
      description: >-
        When set to true, cookie banners are detected and detection events are
        dispatched, but they will not be handled.
        This pref applies to both normal and private browsing windows.
    enableFirefoxDesktopUI:
      type: boolean
      setPref:
        branch: default
        pref: cookiebanners.ui.desktop.enabled
      description: Enables the cookie banner desktop UI.
    enablePromo:
      type: boolean
      setPref:
        branch: default
        pref: browser.promo.cookiebanners.enabled
      description: Enables the cookie banner promo in about:privatebrowsing.
    enableDesktopFeatureCallout:
      type: boolean
      setPref:
        branch: default
        pref: cookiebanners.ui.desktop.showCallout
      description: Enables the cookie banner feature callout on desktop.

backgroundThreads:
  description: Prefs to control MacOS thread priorities for power savings.
  owner: kwright@mozilla.com
  hasExposure: false
  isEarlyStartup: true
  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
  hasExposure: false
  isEarlyStartup: true
  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
  isEarlyStartup: true
  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.os:
      type: boolean
      description: >-
        Make webmail sites display prompts to set Firefox as default OS mailto
        application and another prompt to set the current site as default
        webmail site in Firefox.
      fallbackPref: browser.mailto.dualPrompt.os

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