Add config validation

* Add checks for browsers in config
* Also, send lower case browser names in payload so that
  it doesn't cause mismatch across services

Author: pinanks

commands/storybook.js

@@ -23,7 +23,7 @@ async function storybook(serve, options) {
             resolutions.push(element.join('x'));
         });
         storybookConfig.resolutions = (!resolutions.length) ? 'all' : resolutions.toString();
-        storybookConfig.browsers = (!storybookConfig.browsers.length) ? 'all' : storybookConfig.browsers.toString();
+        storybookConfig.browsers = (!storybookConfig.browsers.length) ? 'all' : storybookConfig.browsers.map(x => x.toLowerCase()).toString();
 
         // Get stories object from stories.json and add url corresponding to every story ID 
         await axios.get(new URL('stories.json', url).href)
@@ -38,7 +38,7 @@ async function storybook(serve, options) {
                         }
                     }
                 }
-                
+
                 if (Object.keys(stories).length === 0) {
                     console.log('[smartui] Error: No stories found');
                     process.exit(0);
@@ -60,7 +60,7 @@ async function storybook(serve, options) {
     } else {
         let dirPath = serve;
         await validateStorybookDir(dirPath);
-        
+
         // Get storyIds to be rendered 
         let storyIds = static.filterStories(dirPath, storybookConfig)
 
@@ -78,7 +78,7 @@ async function storybook(serve, options) {
                         console.log(`[smartui] Cannot compress ${dirPath}. Error: ${err.message}`);
                         process.exit(0);
                     });
-                
+
                 // Upload to S3
                 const zipData = fs.readFileSync('storybook-static.zip');
                 console.log('[smartui] Upload in progress...')
@@ -97,18 +97,22 @@ async function storybook(serve, options) {
                         process.exit(0);
                     });
 
-                // Prepare payload data        
+                // Prepare payload data
+                let browsers = []
                 let resolutions = []
+                storybookConfig.browsers.forEach(element => {
+                    browsers.push(element.toLowerCase());
+                });
                 storybookConfig.resolutions.forEach(element => {
-                    resolutions.push({width: element[0], height: element[1]});
+                    resolutions.push({ width: element[0], height: element[1] });
                 });
                 let commit = await getLastCommit();
                 let payload = {
                     downloadURL: url.substring(url.search(/.com/)+5, url.search(/.zip/)+4),
                     uploadId: uploadId,
                     projectToken: process.env.PROJECT_TOKEN,
                     storybookConfig: {
-                        browsers: storybookConfig.browsers,
+                        browsers: browsers,
                         resolutions: resolutions,
                         storyIds: storyIds
                     },
@@ -132,7 +136,7 @@ async function storybook(serve, options) {
                             console.log('[smartui] Build failed: Error: ', error.response.data.error?.message);
                         } else {
                             console.log('[smartui] Build failed: Error: ', error.message);
-                        }       
+                        }
                     });
             })
             .catch(function (error) {

commands/utils/constants.js

@@ -20,5 +20,6 @@ constants.prod = {
     GET_SIGNED_URL_PATH: "/storybook/url",
     STATIC_RENDER_PATH: "/storybook/staticrender"
 };
+constants.VALID_BROWSERS = ['chrome', 'safari', 'firefox'];
 
 module.exports = { constants };

commands/utils/validate.js

@@ -112,25 +112,33 @@ function validateConfig(configFile) {
 
     // Sanity check browsers
     if (storybookConfig.browsers.length == 0) {
-        console.log('[smartui] Error: Empty browsers list in config.')
+        console.log('[smartui] Error: Empty browsers list in config.');
+        process.exit(0);
+    }
+    if (storybookConfig.browsers.length > constants.VALID_BROWSERS.length) {
+        console.log('[smartui] Error: Invalid or duplicate browsers in config.');
+        process.exit(0);
     }
     storybookConfig.browsers.forEach(element => {
-        if (!(['chrome', 'safari', 'firefox'].includes(element.toLowerCase()))) {
-            console.log('[smartui] Error: Invalid value for browser. Accepted browsers are chrome, safari and firefox');
+        if (!(constants.VALID_BROWSERS.includes(element.toLowerCase()))) {
+            console.log(`[smartui] Error: Invalid value for browser. Accepted browsers are ${constants.VALID_BROWSERS.join(',')}`);
             process.exit(0);
         }
     });
 
     // Sanity check resolutions
     if (storybookConfig.resolutions.length == 0) {
-        console.log('[smartui] Error: Invalid number of resolutions. Min. required - 1')
+        console.log('[smartui] Error: Invalid number of resolutions. Min. required - 1');
+        process.exit(0);
     }
     if (storybookConfig.resolutions.length > 5) {
-        console.log('[smartui] Error: Invalid number of resolutions. Max allowed - 5')
+        console.log('[smartui] Error: Invalid number of resolutions. Max allowed - 5');
+        process.exit(0);
     }
     storybookConfig.resolutions.forEach(element => {
         if (element.length != 2 || element[0] <= 0 || element[1] <= 0) {
             console.log('[smartui] Error: Invalid resolutions.')
+            process.exit(0);
         }
     });