Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
70 changes: 59 additions & 11 deletions src/Safe-Script.js
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,21 @@ const UNOPS = Object.assign(Object.create(null), /** @type {UnaryOperatorTable}
void: () => undefined
}));

/**
* Returned by a member or call link when an optional link (`?.`) met
* `null` or `undefined`: the rest of the chain is skipped and the chain
* evaluates to `undefined`.
*/
const SHORT_CIRCUIT = Symbol('optional chain short-circuit');

/**
* @param {UnknownResult} value
* @returns {boolean}
*/
const isNullish = (value) => {
return value === null || value === undefined;
};

const SafeEval = {
/**
* @param {jsep.Expression} ast
Expand Down Expand Up @@ -182,10 +197,8 @@ const SafeEval = {
case 'Literal':
return SafeEval.evalLiteral(/** @type {jsep.Literal} */ (ast));
case 'MemberExpression':
return SafeEval.evalMemberExpression(
/** @type {jsep.MemberExpression} */ (ast),
subs
);
case 'CallExpression':
return SafeEval.evalChain(ast, subs);
case 'UnaryExpression':
return SafeEval.evalUnaryExpression(
/** @type {jsep.UnaryExpression} */ (ast),
Expand All @@ -196,11 +209,6 @@ const SafeEval = {
/** @type {jsep.ArrayExpression} */ (ast),
subs
);
case 'CallExpression':
return SafeEval.evalCallExpression(
/** @type {jsep.CallExpression} */ (ast),
subs
);
case 'AssignmentExpression':
return SafeEval.evalAssignmentExpression(
/** @type {AssignmentExpression} */ (ast),
Expand Down Expand Up @@ -288,12 +296,50 @@ const SafeEval = {
return ast.value;
},

/**
* Evaluates a whole member/call chain such as `@.a?.b.c()`.
* @param {jsep.Expression} ast
* @param {Substitutions} subs
* @returns {UnknownResult}
*/
evalChain (ast, subs) {
const result = SafeEval.evalChainLink(ast, subs);
return result === SHORT_CIRCUIT ? undefined : result;
},

/**
* Evaluates one link of a member/call chain. Unlike `evalAst`, this
* passes `SHORT_CIRCUIT` up so an earlier `?.` skips the later links.
* @param {jsep.Expression} ast
* @param {Substitutions} subs
* @returns {UnknownResult}
*/
evalChainLink (ast, subs) {
if (ast.type === 'MemberExpression') {
return SafeEval.evalMemberExpression(
/** @type {jsep.MemberExpression} */ (ast),
subs
);
}
if (ast.type === 'CallExpression') {
return SafeEval.evalCallExpression(
/** @type {jsep.CallExpression} */ (ast),
subs
);
}
return SafeEval.evalAst(ast, subs);
},

/**
* @param {jsep.MemberExpression} ast
* @param {Substitutions} subs
* @returns {UnknownResult}
*/
evalMemberExpression (ast, subs) {
const obj = SafeEval.evalChainLink(ast.object, subs);
if (obj === SHORT_CIRCUIT || (ast.optional && isNullish(obj))) {
return SHORT_CIRCUIT;
}
const prop = String(
// NOTE: `String(value)` throws error when
// value has overwritten the toString method to return non-string
Expand All @@ -302,7 +348,6 @@ const SafeEval = {
? SafeEval.evalAst(ast.property, subs) // `object[property]`
: ast.property.name // `object.property` property is Identifier
);
const obj = SafeEval.evalAst(ast.object, subs);
const result = getSafeProperty(obj, prop);
if (typeof result === 'function') {
return result.bind(obj); // arrow functions aren't affected by bind.
Expand Down Expand Up @@ -343,8 +388,11 @@ const SafeEval = {
* @returns {UnknownResult}
*/
evalCallExpression (ast, subs) {
const func = SafeEval.evalChainLink(ast.callee, subs);
if (func === SHORT_CIRCUIT || (ast.optional && isNullish(func))) {
return SHORT_CIRCUIT;
}
const args = ast.arguments.map((arg) => SafeEval.evalAst(arg, subs));
const func = SafeEval.evalAst(ast.callee, subs);
if (
isBlockedFunction(func) ||
args.some((arg) => isBlockedFunction(arg))
Expand Down
55 changes: 55 additions & 0 deletions test/test.safe-eval.js
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,61 @@ checkBuiltInVMAndNodeVM(function (vmType, setBuiltInState) {
});
assert.deepEqual(result, expected);
});
describe('optional chaining in safe mode script', () => {
const shelf = {
books: [
{title: 'A', meta: {tags: ['x']}},
{title: 'B', meta: null},
{title: 'C'}
]
};
/**
* @param {string} path
* @returns {unknown}
*/
const titles = (path) => jsonpath({
json: shelf,
path,
eval: 'safe'
});
it('member access (`?.`)', () => {
assert.deepEqual(
titles('$.books[?(@.meta?.tags[0] === "x")].title'),
['A']
);
assert.deepEqual(
titles('$.books[?(@.meta?.tags === undefined)].title'),
['B', 'C']
);
});
it('computed member access (`?.[]`)', () => {
assert.deepEqual(
titles('$.books[?(@.meta?.["tags"]?.length)].title'),
['A']
);
});
it('call (`?.()`)', () => {
assert.deepEqual(
titles('$.books[?(@.meta?.tags.join("") === "x")].title'),
['A']
);
assert.deepEqual(
titles('$.books[?(@.meta?.nope?.() === undefined)].title'),
['A', 'B', 'C']
);
});
it('skips the rest of the chain', () => {
assert.deepEqual(
titles('$.books[?(n = 0, @.meta?.[n = 1], n === 0)].title'),
['B', 'C']
);
});
it('still throws without `?.`', () => {
assert.throws(() => {
titles('$.books[?(@.meta.tags)].title');
}, /Cannot read properties of null \(reading 'tags'\)/v);
});
});
describe('binary operators in safe mode script', () => {
// eslint-disable-next-line no-shadow -- Convenient
const json = {
Expand Down