some more tweaks to the error output of Tracer. Even though the Tracer is now pretty good at pinpointing where a SyntaxError occurred, it is still removing CREATE TABLE node when there is a failure in the statement, even though that information should be part of the error message. refs #2

Author: nwronski

CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to this project will be documented in this file.
 - forked `pegjs` repository as `nwronski/pegjs` to get the changes into `pegjs` core into version control so they are not accidentally overwritten
 - getting closer to displaying correct error location when there are multiple statements in the input SQL
 
+### Notes
+- Even though the `Tracer` is now pretty good at pinpointing where a SyntaxError occurred, it is still removing `CREATE TABLE` node when there is a failure in the statement, even though that information should be part of the error message.
+
 ## [v0.8.0] - 2015-07-04
 ### Added
 - added several array methods (e.g.: `findLast()`, `takeRight()`, `pluck()`) so that I could remove `lodash` as a dependency of the "smart error" `Tracer` class

demo/sqlite-parser-demo.js

@@ -20,7 +20,7 @@
     });
   }
   sqliteParser['NAME'] = 'sqlite-parser';
-  sqliteParser['VERSION'] = '0.8.2';
+  sqliteParser['VERSION'] = '0.8.3';
 
   module.exports = root.sqliteParser = sqliteParser;
 })(typeof self === 'object' ? self : global);

dist/sqlite-parser.js

@@ -127,8 +127,9 @@ function has(thing, item) {
       return findWhere(thing, item) !== undefined;
     }
   } else if (isPlain(thing)) {
-    // thing is an object
-    if (isPlain(item)) {
+    if (isFunc(item)) {
+      return item(thing);
+    } else if (isPlain(item)) {
       // item is an object, find each prop key and value in item within thing
       for (k in item) {
         v = item[k];

index.js

@@ -24,15 +24,15 @@ module.exports = (function (util) {
         this.indentation += 1;
         break;
       case 'rule.match':
-        /*
-         * TODO: need to remove entire statement from events once fully
-         *       matched as right now the last location from the previous
-         *       statement is reported when there is an error within a
-         *       statement that follows it
-         */
          this.indentation -= 1;
         break;
       case 'rule.fail':
+      /**
+        * @note
+        *   This is removing CREATE TABLE node when there is a failure in
+        *   the statement, even though that information should be part of
+        *   the error message.
+        */
         // remove failed leaf
         this.events.splice(util.findLastIndex(this.events, {rule: event.rule}), 1);
         this.indentation -= 1;
@@ -41,41 +41,43 @@ module.exports = (function (util) {
   };
 
   Tracer.prototype.smartError = function smartError(err) {
-    var message, location, chain, chainDetail,
-        lastIndent = 10000,
-        bestDescriptor = false,
-        multiStatement = false;
+    var message, location, chain, chainDetail, firstNode,
+        bestNode = {indentation: -1},
+        deep = false,
+        stmts = 0,
+        namedEvents = this.events
+        .filter(function (e) {
+          return e.description !== null &&
+                  !/whitespace|(new\sline)|(char$)|(^[oe]$)/i.test(e.description);
+        })
+        .reverse();
 
-    chain = this.events
-    .reverse()
-    .filter(function (e) {
-      // Only use nodes with a set description
-      if (multiStatement) {
+    chain = util.takeWhile(namedEvents, function (elem) {
+      if (/^(sym\_semi)$/i.test(elem.rule)) {
+        stmts += 1;
+      }
+      if (stmts > 1) {
+        return false;
+      }
+      if (!deep) {
+        if (elem.indentation > bestNode.indentation) {
+          bestNode = elem;
+        } else {
+          deep = true;
+        }
+      } else if (/^(stmt)$/i.test(elem.rule)) {
         return false;
-      } else if (/Statement$/i.test(e.description)) {
-        multiStatement = true;
-        return true;
       }
-      return e.description !== null && !/whitespace|(semi$)|(^[oe]$)/i.test(e.rule);
+      return true;
     });
 
     if (chain.length) {
-      // Get best location data
-      location = util.first(chain).location;
-      // Collect descriptions
-      chain = util.uniq(util.takeWhile(util.pluck(chain, 'description'), function (d) {
-        if (!bestDescriptor && /(Statement|Clause)$/i.test(d)) {
-          bestDescriptor = true;
-          return true;
-        }
-        return !bestDescriptor;
-      }))
-      .reverse();
-      // Don't accidentally repeat the first description in the output
-      chainDetail = util.takeRight(util.rest(chain), 2);
-      message = 'Syntax error found near ' + util.first(chain) +
-                (chainDetail.length > 0 ? ' (' + chainDetail.join(', ') + ')' : '');
-      //location = this.events.findLast({description: chain.last()}).location;
+      location = bestNode.location;
+      firstNode = util.findLast(chain.reverse(), function (elem) {
+        return /(Statement|Clause)$/i.test(elem.description);
+      });
+      chainDetail = firstNode != null ? ' (' + firstNode.description + ')' : '';
+      message = 'Syntax error found near ' + bestNode.description + chainDetail;
       util.extend(err, {
         'message': message,
         'location': location

lib/parser-util.js

@@ -2,7 +2,7 @@
   "name": "sqlite-parser",
   "description": "JavaScript implentation of SQLite 3 query parser",
   "author": "Code School (http://codeschool.com)",
-  "version": "0.8.2",
+  "version": "0.8.3",
   "contributors": [
     "Nick Wronski <nick@javascript.com>"
   ],

lib/parser.js

@@ -1102,7 +1102,7 @@ stmt_fallback_types
   { return k; }
 
 /** {@link https://www.sqlite.org/lang_insert.html} */
-stmt_insert
+stmt_insert "INSERT Statement"
   = k:( insert_keyword ) o t:( insert_target ) o p:( insert_parts )
   {
     // TODO: Not final syntax!
@@ -1120,15 +1120,15 @@ insert_keyword
   = insert_keyword_ins
   / insert_keyword_repl
 
-insert_keyword_ins "INSERT Statement"
+insert_keyword_ins
   = a:( INSERT ) e m:( insert_keyword_mod )?
   {
     return util.extend({
       'action': util.key(a)
     }, m);
   }
 
-insert_keyword_repl "REPLACE Statement"
+insert_keyword_repl
   = a:( REPLACE ) e
   {
     return {

lib/tracer.js

@@ -127,8 +127,9 @@ function has(thing, item) {
       return findWhere(thing, item) !== undefined;
     }
   } else if (isPlain(thing)) {
-    // thing is an object
-    if (isPlain(item)) {
+    if (isFunc(item)) {
+      return item(thing);
+    } else if (isPlain(item)) {
       // item is an object, find each prop key and value in item within thing
       for (k in item) {
         v = item[k];