Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize the error output #48

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Standardize the error output #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98ab760
standardize error output
Jun 18, 2019
d427ce8
fix missing semicolon
Jun 18, 2019
356a49c
fix: generation of Error class
Jun 18, 2019
9dee021
fix linting errors
Jun 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 53 additions & 28 deletions jmespath.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,30 @@
ch === "_";
}

function createErrorClass(className) {
function ExtendedError(message) {
var instance = new Error(message);
instance.name = className;
Object.setPrototypeOf(instance, Object.getPrototypeOf(this));
if (Error.captureStackTrace) {
Error.captureStackTrace(instance, ExtendedError);
}
return instance;
}
ExtendedError.prototype = Object.create(Error.prototype, {
constructor: {
value: Error,
enumerable: false,
writeable: true,
configurable: true,
},
});

return ExtendedError;
}

var LexerError = createErrorClass("LexerError");

function Lexer() {
}
Lexer.prototype = {
Expand Down Expand Up @@ -304,8 +328,7 @@
tokens.push({type: TOK_PIPE, value: "|", start: start});
}
} else {
var error = new Error("Unknown character:" + stream[this._current]);
error.name = "LexerError";
var error = new LexerError("Unknown character:" + stream[this._current]);
throw error;
}
}
Expand Down Expand Up @@ -500,6 +523,8 @@
bindingPower[TOK_LBRACKET] = 55;
bindingPower[TOK_LPAREN] = 60;

var ParserError = createErrorClass("ParserError");

function Parser() {
}

Expand All @@ -510,9 +535,8 @@
var ast = this.expression(0);
if (this._lookahead(0) !== TOK_EOF) {
var t = this._lookaheadToken(0);
var error = new Error(
var error = new ParserError(
"Unexpected token type: " + t.type + ", value: " + t.value);
error.name = "ParserError";
throw error;
}
return ast;
Expand Down Expand Up @@ -562,7 +586,7 @@
case TOK_QUOTEDIDENTIFIER:
var node = {type: "Field", name: token.value};
if (this._lookahead(0) === TOK_LPAREN) {
throw new Error("Quoted identifier not allowed for function names.");
throw new ParserError("Quoted identifier not allowed for function names.");
}
return node;
case TOK_NOT:
Expand Down Expand Up @@ -704,17 +728,15 @@
this._advance();
} else {
var t = this._lookaheadToken(0);
var error = new Error("Expected " + tokenType + ", got: " + t.type);
error.name = "ParserError";
var error = new ParserError("Expected " + tokenType + ", got: " + t.type);
throw error;
}
},

_errorToken: function(token) {
var error = new Error("Invalid token (" +
var error = new ParserError("Invalid token (" +
token.type + "): \"" +
token.value + "\"");
error.name = "ParserError";
throw error;
},

Expand Down Expand Up @@ -759,9 +781,8 @@
this._advance();
} else {
var t = this._lookahead(0);
var error = new Error("Syntax error, unexpected token: " +
var error = new ParserError("Syntax error, unexpected token: " +
t.value + "(" + t.type + ")");
error.name = "Parsererror";
throw error;
}
currentToken = this._lookahead(0);
Expand Down Expand Up @@ -805,9 +826,8 @@
right = this._parseDotRHS(rbp);
} else {
var t = this._lookaheadToken(0);
var error = new Error("Sytanx error, unexpected token: " +
var error = new ParserError("Syntax error, unexpected token: " +
t.value + "(" + t.type + ")");
error.name = "ParserError";
throw error;
}
return right;
Expand All @@ -821,7 +841,7 @@
if (this._lookahead(0) === TOK_COMMA) {
this._match(TOK_COMMA);
if (this._lookahead(0) === TOK_RBRACKET) {
throw new Error("Unexpected token Rbracket");
throw new ParserError("Unexpected token Rbracket");
}
}
}
Expand All @@ -836,7 +856,7 @@
for (;;) {
keyToken = this._lookaheadToken(0);
if (identifierTypes.indexOf(keyToken.type) < 0) {
throw new Error("Expecting an identifier token, got: " +
throw new ParserError("Expecting an identifier token, got: " +
keyToken.type);
}
keyName = keyToken.value;
Expand All @@ -856,6 +876,7 @@
}
};

var InterpreterError = createErrorClass("InterpreterError");

function TreeInterpreter(runtime) {
this.runtime = runtime;
Expand Down Expand Up @@ -997,7 +1018,7 @@
result = first <= second;
break;
default:
throw new Error("Unknown comparator: " + node.name);
throw new InterpreterError("Unknown comparator: " + node.name);
}
return result;
case TOK_FLATTEN:
Expand Down Expand Up @@ -1073,7 +1094,7 @@
refNode.jmespathType = TOK_EXPREF;
return refNode;
default:
throw new Error("Unknown node type: " + node.type);
throw new InterpreterError("Unknown node type: " + node.type);
}
},

Expand Down Expand Up @@ -1122,6 +1143,10 @@

};

var RuntimeError = createErrorClass("RuntimeError");
var ArgumentError = createErrorClass("ArgumentError");
var TypeMismatchError = createErrorClass("TypeMismatchError");

function Runtime(interpreter) {
this._interpreter = interpreter;
this.functionTable = {
Expand Down Expand Up @@ -1209,7 +1234,7 @@
callFunction: function(name, resolvedArgs) {
var functionEntry = this.functionTable[name];
if (functionEntry === undefined) {
throw new Error("Unknown function: " + name + "()");
throw new RuntimeError("Unknown function: " + name + "()");
}
this._validateArgs(name, resolvedArgs, functionEntry._signature);
return functionEntry._func.call(this, resolvedArgs);
Expand All @@ -1225,13 +1250,13 @@
if (signature[signature.length - 1].variadic) {
if (args.length < signature.length) {
pluralized = signature.length === 1 ? " argument" : " arguments";
throw new Error("ArgumentError: " + name + "() " +
throw new ArgumentError(name + "() " +
"takes at least" + signature.length + pluralized +
" but received " + args.length);
}
} else if (args.length !== signature.length) {
pluralized = signature.length === 1 ? " argument" : " arguments";
throw new Error("ArgumentError: " + name + "() " +
throw new ArgumentError(name + "() " +
"takes " + signature.length + pluralized +
" but received " + args.length);
}
Expand All @@ -1254,7 +1279,7 @@
return TYPE_NAME_TABLE[typeIdentifier];
})
.join(',');
throw new Error("TypeError: " + name + "() " +
throw new TypeMismatchError(name + "() " +
"expected argument " + (i + 1) +
" to be type " + expected +
" but received type " +
Expand Down Expand Up @@ -1547,7 +1572,7 @@
var requiredType = this._getTypeName(
interpreter.visit(exprefNode, sortedArray[0]));
if ([TYPE_NUMBER, TYPE_STRING].indexOf(requiredType) < 0) {
throw new Error("TypeError");
throw new TypeMismatchError("Array elements must be of type Number or String to sort");
}
var that = this;
// In order to get a stable sort out of an unstable
Expand All @@ -1565,12 +1590,12 @@
var exprA = interpreter.visit(exprefNode, a[1]);
var exprB = interpreter.visit(exprefNode, b[1]);
if (that._getTypeName(exprA) !== requiredType) {
throw new Error(
"TypeError: expected " + requiredType + ", received " +
throw new TypeMismatchError(
"expected " + requiredType + ", received " +
that._getTypeName(exprA));
} else if (that._getTypeName(exprB) !== requiredType) {
throw new Error(
"TypeError: expected " + requiredType + ", received " +
throw new TypeMismatchError(
"expected " + requiredType + ", received " +
that._getTypeName(exprB));
}
if (exprA > exprB) {
Expand Down Expand Up @@ -1631,9 +1656,9 @@
var keyFunc = function(x) {
var current = interpreter.visit(exprefNode, x);
if (allowedTypes.indexOf(that._getTypeName(current)) < 0) {
var msg = "TypeError: expected one of " + allowedTypes +
var msg = "expected one of " + allowedTypes +
", received " + that._getTypeName(current);
throw new Error(msg);
throw new TypeMismatchError(msg);
}
return current;
};
Expand Down
1 change: 1 addition & 0 deletions test/jmespath.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ describe('search', function() {
assert(e.message.search(
'expected argument 1 to be type string,array,object'
), e.message);
assert.strictEqual(e.name, 'TypeMismatchError');
assert(e.message.search('received type null'), e.message);
}
}
Expand Down