Add migrate command to convert JSON rules to Bolt language

bin/firebase-bolt

@@ -26,13 +26,16 @@ var pkg = require('../package.json');
 
 var VERSION_STRING = "Firebase Bolt v" + pkg.version;
 
+var commandName = 'bolt';
+
 var opts = {
   boolean: ['version', 'help'],
   string: ['output'],
   alias: {
-    'v': 'version',
+    'f': 'functions',
     'h': 'help',
     'o': 'output',
+    'v': 'version',
   },
   unknown: function(flag) {
     if (flag[0] == '-') {
@@ -42,6 +45,33 @@ var opts = {
   }
 };
 
+var commands = {
+  migrate: function(args) {
+    if (args._.length != 2) {
+      log("Missing JSON file name to migrate to bolt file.");
+      process.exit(1);
+    }
+    var functionsFileName = getInputFileName(args.functions, 'bolt');
+    var functions;
+    if (functionsFileName !== undefined) {
+      readInputFile(functionsFileName, 'Bolt', function(boltText) {
+        try {
+          var symbols = bolt.parse(boltText);
+          functions = symbols.functions;
+        } catch (e) {
+          log(e.message, e.line, e.column);
+          process.exit(1);
+        }
+      });
+    }
+    var inputFileName = getInputFileName(args._[1], 'json');
+    var outputFileName = getOutputFileName(args.output, inputFileName, 'bolt');
+    readInputFile(inputFileName, 'JSON', function(jsonData) {
+      writeOutputFile(outputFileName, bolt.decodeRules(jsonData, functions));
+    });
+  }
+};
+
 function main() {
   var args = parseArgs(process.argv.slice(2), opts);
 
@@ -60,73 +90,105 @@ function main() {
     usage(0);
   }
 
+  // command file
+  if (args._.length >= 1 && commands[args._[0]] !== undefined) {
+    commandName += '-' + args._[0];
+    commands[args._[0]](args);
+    return;
+  }
+
   if (args._.length > 1) {
     log("Can only compile a single file.");
     usage(1);
   }
 
-  // Read Bolt file from stdin
-  if (args._.length === 0) {
-    if (process.stdin.isTTY) {
-      log("Type in a Bolt file terminated by CTRL-D.");
-    }
-    readFile(process.stdin, function(data) {
-      if (args.output !== undefined) {
-        writeTranslation(util.ensureExtension(args.output, 'json'), data);
-      } else {
-        console.log(translateRules(data));
-      }
-    });
-    return;
+  var inputFileName = getInputFileName(args._[0], 'bolt');
+  var outputFileName = getOutputFileName(args.output, inputFileName, 'json');
+  readInputFile(inputFileName, 'Bolt', function(boltData) {
+    writeOutputFile(outputFileName, translateRules(boltData));
+  });
+}
+
+function getInputFileName(name, extension) {
+  // Read file from stdin
+  if (name === undefined) {
+    return undefined;
   }
+  return util.ensureExtension(name, extension);
+}
 
-  // Read Bolt file and write json file.
-  var inFile = util.ensureExtension(args._[0], bolt.FILE_EXTENSION);
-  var outFile;
-  if (args.output) {
-    outFile = util.ensureExtension(args.output, 'json');
+function getOutputFileName(name, inputFileName, extension) {
+  if (name === undefined) {
+    if (inputFileName === undefined) {
+      return undefined;
+    }
+    name = util.replaceExtension(inputFileName, extension);
   } else {
-    outFile = util.replaceExtension(inFile, 'json');
+    name = util.ensureExtension(name, extension);
   }
-  if (inFile === outFile) {
-    log("Cannot overwrite input file: " + inFile);
-    log("(Did you mean '" + util.replaceExtension(inFile, 'bolt') + "'?)");
+  if (name === inputFileName) {
+    log("Cannot overwrite input file: " + inputFileName);
+    log("(Did you mean '" +
+        util.replaceExtension(name, extension == 'json' ? 'bolt' : 'json') +
+        "'?)");
     process.exit(1);
   }
-  fs.readFile(inFile, 'utf8', function(err, data) {
+  return name;
+}
+
+function readInputFile(name, kind, callback) {
+  if (name === undefined) {
+    if (process.stdin.isTTY) {
+      log("Type in a " + kind + " file terminated by CTRL-D.");
+    }
+    readStream(process.stdin, callback);
+    return;
+  }
+
+  fs.readFile(name, 'utf8', function(err, data) {
     if (err) {
-      log("Could not read file: " + inFile);
+      log("Could not read file: " + name);
       process.exit(1);
     }
-    writeTranslation(outFile, data);
+    callback(data);
   });
 }
 
-function writeTranslation(outFile, data) {
-  log("Generating " + outFile + "...");
-  fs.writeFile(outFile, translateRules(data) + '\n', 'utf8', function(err2) {
-    if (err2) {
-      log("Could not write file: " + outFile);
-      process.exit(1);
-    }
-  });
+function writeOutputFile(name, data) {
+  if (name === undefined) {
+    console.log(data + '\n');
+  } else {
+    log("Generating " + name + "...");
+    fs.writeFile(name, data + '\n', 'utf8', function(err) {
+      if (err) {
+        log("Could not write file: " + outputFile);
+        process.exit(1);
+      }
+    });
+  }
 }
 
 function usage(code) {
   var cmdName = process.argv[1].split('/').slice(-1);
-  console.error("Translate Firebase Bolt file into JSON rules format.\n");
+  console.error("Translate Firebase Bolt file into JSON rules format");
+  console.error("  (or use migrate sub-command to generate a Bolt file equivalent\n" +
+                "   of a Firebase JSON rule set).\n");
 
-  console.error("  Usage: " + cmdName + " [options] [file]\n");
+  console.error("  Usage: " + cmdName + " [options] [file[.bolt]]");
+  console.error("         " + cmdName + " [options] migrate [file[.json]]\n");
 
-  console.error("  Examples: " + cmdName + " myapp.bolt --output rules.json");
-  console.error("            " + cmdName + " < myapp.bolt > rules.json");
-  console.error("            " + cmdName + " myapp");
-  console.error("              (myapp.bolt =>  myapp.json)\n");
+  console.error("  Examples: " + cmdName + " rules.bolt --output rules.json");
+  console.error("            " + cmdName + " < rules.bolt > rules.json");
+  console.error("            " + cmdName + " rules");
+  console.error("              (rules.bolt =>  rules.json)");
+  console.error("            " + cmdName + " migrate [--functions file] rules.json");
+  console.error("              (rules.json =>  rules.bolt)\n");
 
   console.error("  Options:\n");
   console.error(util.formatColumns(4, [
+    ["-f --functions file", "Include file of top level Bolt functions (for migrate)."],
     ["-h --help", "Display this helpful message."],
-    ["-o --output file", "Output to file.json."],
+    ["-o --output file", "Output to file."],
     ["-v --version", "Display Firebase Bolt version."],
     []
   ]).join('\n'));
@@ -136,7 +198,7 @@ function usage(code) {
 
 main();
 
-function readFile(f, callback) {
+function readStream(f, callback) {
   var input = "";
 
   f.setEncoding('utf8');
@@ -172,7 +234,7 @@ function translateRules(input) {
 }
 
 function log(message, line, column) {
-  var parts = ['bolt'];
+  var parts = [commandName];
   if (line) {
     util.extendArray(parts, [line, column]);
   }

gulpfile.js

@@ -36,8 +36,16 @@ var TS_SOURCES = ['src/*.ts',
                   'src/test/*.ts'];
 
 // Subset of tests required for 'gulp test'.
-var TEST_FILES = ['lib/test/generator-test.js', 'lib/test/parser-test.js',
-                  'lib/test/ast-test.js', 'lib/test/util-test.js', 'lib/test/cli-test.js'];
+var TEST_FILES = [
+  'lib/test/ast-test.js',
+  'lib/test/cli-test.js',
+  'lib/test/decoder-test.js',
+  'lib/test/generator-test.js',
+  'lib/test/matcher-test.js',
+  'lib/test/parser-test.js',
+  'lib/test/permutation-test.js',
+  'lib/test/util-test.js'
+];
 
 // Ignore ts-compile errors while watching (but not in normal builds).
 var watching = false;

package.json

@@ -70,6 +70,7 @@
     "minimist": "^1.2.0",
     "mocha": "^2.2.5",
     "node-uuid": "^1.4.3",
-    "promise": "^7.0.4"
+    "promise": "^7.0.4",
+    "strip-json-comments": "^2.0.0"
   }
 }

samples/chat.json

@@ -7,7 +7,7 @@
           ".validate": "newData.val().length > 0 && newData.val().length <= 32"
         },
         "creator": {
-          ".validate": "newData.isString() && (auth != null && newData.val() == auth.uid)"
+          ".validate": "newData.isString() && auth != null && newData.val() == auth.uid"
         },
         "members": {
           "$key2": {
@@ -21,7 +21,7 @@
             "$other": {
               ".validate": "false"
             },
-            ".write": "data.val() == null && (auth != null && $key2 == auth.uid)"
+            ".write": "data.val() == null && auth != null && $key2 == auth.uid"
           }
         },
         "$other": {
@@ -37,15 +37,15 @@
         "$postid": {
           ".validate": "newData.hasChildren(['from', 'message', 'created'])",
           "from": {
-            ".validate": "newData.isString() && (auth != null && newData.val() == auth.uid)"
+            ".validate": "newData.isString() && auth != null && newData.val() == auth.uid"
           },
           "message": {
             ".validate": "newData.isString() && newData.val().length > 0 && newData.val().length <= 140"
           },
           "$other": {
             ".validate": "false"
           },
-          ".write": "data.val() == null && (root.child('rooms').child($roomid).child('members').child(auth.uid).val() != null && !(root.child('rooms').child($roomid).child('members').child(auth.uid).child('isBanned').val() == true))",
+          ".write": "data.val() == null && root.child('rooms').child($roomid).child('members').child(auth.uid).val() != null && !(root.child('rooms').child($roomid).child('members').child(auth.uid).child('isBanned').val() == true)",
           "created": {
             ".validate": "newData.isNumber() && newData.val() == (data.val() == null ? now : data.val())"
           }

samples/decoded.bolt

@@ -0,0 +1,6 @@
+// Bolt file auto-generated from JSON file.
+path /users/$uid {
+  read() = auth != null;
+  write() = auth != null && auth.uid == $uid;
+}
+path /users/$uid/name is String;

samples/decoded.json

@@ -0,0 +1,13 @@
+{
+  "rules": {
+    "users": {
+      "$uid": {
+        ".read": "auth != null",
+        ".write": "auth != null && auth.uid == $uid",
+        "name": {
+          ".validate": "newData.isString()"
+        }
+      }
+    }
+  }
+}

samples/mail.json

@@ -4,7 +4,7 @@
       "$userid": {
         "inbox": {
           "$msg": {
-            ".validate": "newData.hasChildren(['from', 'to', 'message']) && data.val() == null && (auth != null && auth.uid == newData.child('from').val())",
+            ".validate": "newData.hasChildren(['from', 'to', 'message']) && data.val() == null && auth != null && auth.uid == newData.child('from').val()",
             "from": {
               ".validate": "newData.isString()"
             },
@@ -23,7 +23,7 @@
         },
         "outbox": {
           "$msg": {
-            ".validate": "newData.hasChildren(['from', 'to', 'message']) && data.val() == null && (auth != null && auth.uid == newData.child('from').val())",
+            ".validate": "newData.hasChildren(['from', 'to', 'message']) && data.val() == null && auth != null && auth.uid == newData.child('from').val()",
             "from": {
               ".validate": "newData.isString()"
             },

samples/user-security.json

@@ -21,7 +21,7 @@
         "$message_id": {
           ".validate": "newData.hasChildren(['user', 'message', 'timestamp']) && data.val() == null",
           "user": {
-            ".validate": "newData.isString() && (auth != null && auth.uid == newData.val())"
+            ".validate": "newData.isString() && auth != null && auth.uid == newData.val()"
           },
           "message": {
             ".validate": "newData.isString() && newData.val().length > 0 && newData.val().length < 50"