Merge pull request #30 from firebase/v1.1.2

v1.1.2

Author: Chris Raynor

CHANGELOG.md

@@ -1,3 +1,6 @@
+## v1.1.2
+- Adds client-side validation of new advanced features with better error messaging
+
 ## v1.1.1
 - Adds a brief description of each template inline when running `firebase bootstrap`
 
@@ -26,4 +29,4 @@
 ## v1.0.1
 - Fixes bug with `firebase bootstrap` on windows
 - Adds 'ignore' to `firebase.json` to allow files to be ignored on deploy
-- Prioritizes `--email` and `--password` command line arguments over current auth token if both passed
+- Prioritizes `--email` and `--password` command line arguments over current auth token if both passed

lib/app.js

@@ -75,8 +75,7 @@ function updateRules(settings, tokens) {
 
 function updateRedirects(firebaseRef, settings) {
   return _when.promise(function(resolve, reject, notify) {
-    var redirects = settings.redirects || null;
-    firebaseRef.child('hosting/path-redirects').child(settings.firebase).set(redirects, function(err) {
+    firebaseRef.child('hosting/path-redirects').child(settings.firebase).set(settings.redirects, function(err) {
       if (err) {
         console.log(chalk.red('Settings Error') + ' - Incorrectly formatted "redirects" entry in the firebase.json');
         process.exit(1);
@@ -88,8 +87,7 @@ function updateRedirects(firebaseRef, settings) {
 
 function updateRewrites(firebaseRef, settings) {
   return _when.promise(function(resolve, reject, notify) {
-    var rewrites = settings.rewrites || null;
-    firebaseRef.child('hosting/rewrites').child(settings.firebase).set(rewrites, function(err) {
+    firebaseRef.child('hosting/rewrites').child(settings.firebase).set(settings.rewrites, function(err) {
       if (err) {
         console.log(chalk.red('Settings Error') + ' - Incorrectly formatted "rewrites" entry in the firebase.json');
         process.exit(1);
@@ -101,8 +99,7 @@ function updateRewrites(firebaseRef, settings) {
 
 function updateHeaders(firebaseRef, settings) {
   return _when.promise(function(resolve, reject, notify) {
-    var headers = settings.headers || null;
-    firebaseRef.child('hosting/headers').child(settings.firebase).set(headers, function(err) {
+    firebaseRef.child('hosting/headers').child(settings.firebase).set(settings.headers, function(err) {
       if (err) {
         console.log(chalk.red('Settings Error') + ' - Incorrectly formatted "headers" entry in the firebase.json');
         process.exit(1);
@@ -112,6 +109,122 @@ function updateHeaders(firebaseRef, settings) {
   });
 }
 
+function validateRedirects(redirects) {
+  var error = null;
+  if (redirects) {
+    if (!Array.isArray(redirects)) {
+      error = 'Redirects entry in the firebase.json must be an Array.';
+    } else {
+      for (var i = 0; i < redirects.length; i++) {
+        var redirect = redirects[i];
+        if (typeof redirect !== 'object') {
+          error = 'Redirect rule: ' + JSON.stringify(redirect) + ' Must be an object.';
+        } else if (!redirect.source || typeof redirect.source !== 'string' || redirect.source.length == 0) {
+          error = 'Redirect rule: ' + JSON.stringify(redirect) + ' Must contain a "source" attribute that\'s a non-empty string.';
+        } else if (!redirect.destination || typeof redirect.destination !== 'string' || redirect.destination.length == 0) {
+          error = 'Redirect rule: ' + JSON.stringify(redirect) + ' Must contain a "destination" attribute that\'s a non-empty string.';
+        } else if (!/^(\/[^\s]*|https?:\/\/[^\s]+)$/.test(redirect.destination)) {
+          error = 'Redirect destination: "' + redirect.destination + '" Must be a remote or absolute url and start with "http", "https", or a "/".';
+        } else if (redirect.type !== 301 && redirect.type !== 302) {
+          error = 'Redirect rule: ' + JSON.stringify(redirect) + ' Must have a redirect "type" that\'s either 301 for a permanent redirect or 302 for a temporary redirect.';
+        } else if (Object.keys(redirect).length > 3) {
+          error = 'Redirect rule: ' + JSON.stringify(redirect) + ' Must not contain any keys other than "source", "destination", or "type".';
+        }
+        if (error) {
+          break;
+        }
+      }
+    }
+  }
+  if (error) {
+    console.log(chalk.red('Settings Error') + ' - ' + error);
+    process.exit(1);
+  }
+}
+
+function validateRewrites(rewrites) {
+  var error = null;
+  if (rewrites) {
+    if (!Array.isArray(rewrites)) {
+      error = 'Rewrites entry in the firebase.json must be an Array.';
+    } else {
+      for (var i = 0; i < rewrites.length; i++) {
+        var rewrite = rewrites[i];
+        if (typeof rewrite !== 'object') {
+          error = 'Rewrite rule: ' + JSON.stringify(rewrite) + ' Must be an object.';
+        } else if (!rewrite.source || typeof rewrite.source !== 'string' || rewrite.source.length == 0) {
+          error = 'Rewrite rule: ' + JSON.stringify(rewrite) + ' Must contain a "source" attribute that\'s a non-empty string.';
+        } else if (!rewrite.destination || typeof rewrite.destination !== 'string' || rewrite.destination.length == 0) {
+          error = 'Rewrite rule: ' + JSON.stringify(rewrite) + ' Must contain a "destination" attribute that\'s a non-empty string.';
+        } else if (!/^\/[^\s]*[^\/\s]$/.test(rewrite.destination)) {
+          error = 'Rewrite destination: "' + rewrite.destination + '" Must be an absolute path to a file that starts with a "/" and does not end in a "/".';
+        } else if (Object.keys(rewrite).length > 2) {
+          error = 'Rewrite rule: ' + JSON.stringify(rewrite) + ' Must not contain any keys other than "source" or "destination".';
+        }
+        if (error) {
+          break;
+        }
+      }
+    }
+  }
+  if (error) {
+    console.log(chalk.red('Settings Error') + ' - ' + error);
+    process.exit(1);
+  }
+}
+
+function validateHeaders(headers) {
+  var error = null,
+      supportedHeaders = [
+        'Access-Control-Allow-Origin',
+        'Cache-Control'
+      ];
+  if (headers) {
+    if (!Array.isArray(headers)) {
+      error = 'Headers entry in the firebase.json must be an Array.';
+    } else {
+      for (var i = 0; i < headers.length; i++) {
+        var header = headers[i];
+        if (typeof header !== 'object') {
+          error = 'Header rule: ' + JSON.stringify(header) + ' Must be an object.';
+        } else if (!header.source || typeof header.source !== 'string' || header.source.length === 0) {
+          error = 'Header rule: ' + JSON.stringify(header) + ' Must contain a "source" attribute that\'s a non-empty string.';
+        } else if (!header.headers || !Array.isArray(header.headers)) {
+          error = 'Header rule: ' + JSON.stringify(header) + ' Must contain a "headers" attribute that\'s an array.';
+        } else if (Object.keys(header).length > 2) {
+          error = 'Header rule: ' + JSON.stringify(header) + ' Must not contain any keys other than "source" or "headers".';
+        }
+        if (!error) {
+          for (var j = 0; j < header.headers.length; j++) {
+            var individualHeader = header.headers[j];
+            if (typeof individualHeader !== 'object') {
+              error = 'Header: ' + JSON.stringify(individualHeader) + ' Must be an object';
+            } else if (!individualHeader['key'] || typeof individualHeader['key'] !== 'string' || individualHeader['key'].length === 0) {
+              error = 'Header: ' + JSON.stringify(individualHeader) + ' Must contain a "key" field that\'s one of: "' + supportedHeaders.join('", "') + '"';
+            } else if (!individualHeader['value'] || typeof individualHeader['value'] !== 'string' || individualHeader['value'].length === 0) {
+              error = 'Header: ' + JSON.stringify(individualHeader) + ' Must contain a "value" field that\'s a non-empty string.';
+            } else if (supportedHeaders.indexOf(individualHeader['key']) < 0) {
+              error = 'Header key: "' + individualHeader['key'] + '" is not supported. Supported keys are: "' + supportedHeaders.join('", "') + '"';
+            } else if (Object.keys(individualHeader).length > 2) {
+              error = 'Header: ' + JSON.stringify(individualHeader) + ' Must not contain any keys other than "key" or "value".';
+            }
+            if (error) {
+              break;
+            }
+          }
+        }
+        if (error) {
+          break;
+        }
+      }
+    }
+  }
+  if (error) {
+    console.log(chalk.red('Settings Error') + ' - ' + error);
+    process.exit(1);
+  }
+}
+
 function uploadSite(settings, directoryRef, argv) {
   return function() {
     var bar = null;
@@ -520,6 +633,13 @@ module.exports = {
           process.exit(1);
         }
 
+        settings.rewrites = settings.rewrites || null;
+        validateRewrites(settings.rewrites);
+        settings.redirects = settings.redirects || null;
+        validateRedirects(settings.redirects);
+        settings.headers = settings.headers || null;
+        validateHeaders(settings.headers);
+
         var firebaseRef = new Firebase(api.realtimeUrl.replace(/\/\//, '//firebase.'));
         firebaseRef.auth(tokens.firebaseToken, function(error, result) {
           if (error) {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "firebase-tools",
   "preferGlobal": true,
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "The Firebase Command Line Tools",
   "keywords": [
     "firebase",