Bug 1717622 - Make descriptions required for nimbus variables, disallow additional properties r=k88hudson

Differential Revision: https://phabricator.services.mozilla.com/D119410

toolkit/components/nimbus/FeatureManifest.js

@@ -60,21 +60,28 @@ const FeatureManifest = {
       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.",
       },
       screens: {
         type: "json",
         fallbackPref: "browser.aboutwelcome.screens",
+        description: "Content to show in the onboarding flow",
       },
       isProton: {
         type: "boolean",
         fallbackPref: "browser.aboutwelcome.protonDesign",
+        description: "Is it using the latest (proton) design",
       },
       skipFocus: {
         type: "boolean",
         fallbackPref: "browser.aboutwelcome.skipFocus",
+        description:
+          "Should the urlbar should be focused when users first land on about:welcome?",
       },
       transitions: {
         type: "boolean",
+        description: "Enable transition effect between screens",
       },
     },
   },
@@ -85,6 +92,7 @@ const FeatureManifest = {
       enabled: {
         type: "boolean",
         fallbackPref: "browser.startup.homepage.abouthome_cache.enabled",
+        description: "Is the feature enabled?",
       },
     },
   },
@@ -96,14 +104,17 @@ const FeatureManifest = {
         type: "boolean",
         fallbackPref:
           "browser.newtabpage.activity-stream.newNewtabExperience.enabled",
+        description: "Is the new UI enabled?",
       },
       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",
       },
     },
   },
@@ -112,6 +123,7 @@ const FeatureManifest = {
     variables: {
       directMigrateSingleProfile: {
         type: "boolean",
+        description: "Enable direct migration?",
       },
     },
   },
@@ -121,10 +133,12 @@ const FeatureManifest = {
     variables: {
       disablePin: {
         type: "boolean",
+        description: "Disable pin to taskbar feature",
       },
       setDefaultBrowserUserChoice: {
         type: "boolean",
         fallbackPref: "browser.shell.setDefaultBrowserUserChoice",
+        description: "Should it set as default browser",
       },
     },
   },
@@ -135,6 +149,7 @@ const FeatureManifest = {
       enabled: {
         type: "boolean",
         fallbackPref: "browser.startup.upgradeDialog.enabled",
+        description: "Is the feature enabled?",
       },
     },
   },
@@ -144,65 +159,87 @@ const FeatureManifest = {
       infoEnabled: {
         type: "boolean",
         fallbackPref: "browser.privatebrowsing.infoEnabled",
+        description: "Should we show the info section.",
       },
       infoIcon: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.infoIcon",
+        description:
+          "Icon shown in the left side of the info section. Default is the private browsing icon.",
       },
       infoTitle: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.infoTitle",
+        description: "Is the title in the info section enabled.",
       },
       infoTitleEnabled: {
         type: "boolean",
         fallbackPref: "browser.privatebrowsing.infoTitleEnabled",
+        description: "Is the title in the info section enabled.",
       },
       infoBody: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.infoBody",
+        description: "Text content in the info section.",
       },
       infoLinkText: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.infoLinkText",
+        description: "Text for the link in the info section.",
       },
       infoLinkUrl: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.infoLinkUrl",
+        description: "URL for the info section link.",
       },
       promoEnabled: {
         type: "boolean",
         fallbackPref: "browser.privatebrowsing.promoEnabled",
+        description: "Should we show the promo section.",
       },
       promoSectionStyle: {
         type: "string",
+        description:
+          "Sets the position of the promo section. Possible values are: top, below-search, bottom. Default bottom.",
       },
       promoTitle: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.promoTitle",
+        description: "The text content of the promo section.",
       },
       promoTitleEnabled: {
         type: "boolean",
         fallbackPref: "browser.privatebrowsing.promoTitleEnabled",
+        description: "Should we show text content in the promo section.",
       },
       promoLinkText: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.promoLinkText",
+        description: "The text of the link in the promo box.",
       },
       promoHeader: {
         type: "string",
+        description: "The title of the promo section.",
       },
       promoLinkUrl: {
         type: "string",
         fallbackPref: "browser.privatebrowsing.promoLinkUrl",
+        description: "URL for link in the promo box.",
       },
       promoLinkType: {
         type: "string",
+        description:
+          "Type of promo link type. Possible values: link, button. Default is link.",
       },
       promoImageLarge: {
         type: "string",
+        description:
+          "URL for image used on the left side of the promo box, larger, showcases some feature. Default off.",
       },
       promoImageSmall: {
         type: "string",
+        description:
+          "URL for image used on the right side of the promo box, smaller, usually a logo. Default off.",
       },
     },
   },

toolkit/components/nimbus/schemas/ExperimentFeatureManifest.schema.json

@@ -16,22 +16,6 @@
         "variables": {
           "additionalProperties": false,
           "type": "object",
-          "properties": {
-            "enabled": {
-              "additionalProperties": false,
-              "type": "object",
-              "properties": {
-                "type": {
-                  "type": "string",
-                  "const": "boolean"
-                },
-                "fallbackPref": {
-                  "type": "string"
-                }
-              },
-              "required": ["type"]
-            }
-          },
           "patternProperties": {
             "[a-zA-Z0-9_]+": {
               "type": "object",
@@ -42,9 +26,14 @@
                 },
                 "fallbackPref": {
                   "type": "string"
+                },
+                "description": {
+                  "type": "string",
+                  "description": "Explain how this value is being used"
                 }
               },
-              "required": ["type"]
+              "required": ["type", "description"],
+              "additionalProperties": false
             }
           }
         }