Skip to content

feat(evaluate): emit parse error on invalid JSONPointer #185

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

Merged
char0n merged 1 commit into from
Jan 23, 2026
Merged

feat(evaluate): emit parse error on invalid JSONPointer #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
"SECURITY.md"
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR description contains a typo: "busclasses" should be "subclasses". The description should read: "BREAKING CHANGE: evaluate can now throw either JSONPointerParseError or subclasses of JSONPointerEvaluateError."

Copilot uses AI. Check for mistakes.
],
"dependencies": {
"apg-lite": "^1.0.4"
"apg-lite": "^1.0.5"
},
"devDependencies": {
"@babel/cli": "=7.28.6",
Expand Down
19 changes: 8 additions & 11 deletions src/evaluate/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import testArrayDash from '../test/array-dash.js';
import testArrayIndex from '../test/array-index.js';
import TraceBuilder from './trace/TraceBuilder.js';
import JSONRealm from './realms/json/index.js';
import JSONPointerParseError from '../errors/JSONPointerParseError.js';
import JSONPointerEvaluateError from '../errors/JSONPointerEvaluateError.js';
import JSONPointerTypeError from '../errors/JSONPointerTypeError.js';
import JSONPointerIndexError from '../errors/JSONPointerIndexError.js';
Expand All @@ -19,6 +20,13 @@ const evaluate = (
trace: parseTrace,
} = parse(jsonPointer, { trace: !!trace });

if (!parseResult.success) {
let message = `Invalid JSON Pointer: "${jsonPointer}". Syntax error at position ${parseResult.maxMatched}`;
message += parseTrace ? `, expected ${parseTrace.inferExpectations()}` : '';

throw new JSONPointerParseError(message, { jsonPointer });
}

const tracer =
typeof trace === 'object' && trace !== null
? new TraceBuilder(trace, {
Expand All @@ -34,17 +42,6 @@ const evaluate = (
try {
let output;

if (!parseResult.success) {
let message = `Invalid JSON Pointer: "${jsonPointer}". Syntax error at position ${parseResult.maxMatched}`;
message += parseTrace ? `, expected ${parseTrace.inferExpectations()}` : '';

throw new JSONPointerEvaluateError(message, {
jsonPointer,
currentValue: value,
realm: realm.name,
});
}

return referenceTokens.reduce((current, referenceToken, referenceTokenPosition) => {
if (realm.isArray(current)) {
if (testArrayDash(referenceToken)) {
Expand Down
5 changes: 3 additions & 2 deletions test/evaluate/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerParseError,
JSONPointerEvaluateError,
URIFragmentIdentifier,
} from '../../src/index.js';
Expand Down Expand Up @@ -85,8 +86,8 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(data, 'invalid-pointer'), JSONPointerEvaluateError);
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(data, 'invalid-pointer'), JSONPointerParseError);
});

specify(
Expand Down
6 changes: 3 additions & 3 deletions test/evaluate/realms/apidom/evaluate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerEvaluateError,
JSONPointerParseError,
URIFragmentIdentifier,
} from '../../../../src/index.js';
import { evaluate } from '../../../../src/evaluate/realms/apidom/index.js';
Expand Down Expand Up @@ -91,8 +91,8 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(element, 'invalid-pointer'), JSONPointerEvaluateError);
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(element, 'invalid-pointer'), JSONPointerParseError);
});

specify(
Expand Down
6 changes: 3 additions & 3 deletions test/evaluate/realms/apidom/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerEvaluateError,
JSONPointerParseError,
URIFragmentIdentifier,
} from '../../../../src/index.js';
import ApiDOMEvaluationRealm from '../../../../src/evaluate/realms/apidom/index.js';
Expand Down Expand Up @@ -101,10 +101,10 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(
() => evaluate(element, 'invalid-pointer', { realm }),
JSONPointerEvaluateError,
JSONPointerParseError,
);
});

Expand Down
6 changes: 3 additions & 3 deletions test/evaluate/realms/immutable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerEvaluateError,
JSONPointerParseError,
URIFragmentIdentifier,
} from '../../../src/index.js';
import ImmutableEvaluationRealm from '../../../src/evaluate/realms/immutable/index.js';
Expand Down Expand Up @@ -82,8 +82,8 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(map, 'invalid-pointer', { realm }), JSONPointerEvaluateError);
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(map, 'invalid-pointer', { realm }), JSONPointerParseError);
});

specify(
Expand Down
6 changes: 3 additions & 3 deletions test/evaluate/realms/map-set.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerEvaluateError,
JSONPointerParseError,
URIFragmentIdentifier,
} from '../../../src/index.js';
import MapSetEvaluationRealm from '../../../src/evaluate/realms/map-set/index.js';
Expand Down Expand Up @@ -76,8 +76,8 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(data, 'invalid-pointer', { realm }), JSONPointerEvaluateError);
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(() => evaluate(data, 'invalid-pointer', { realm }), JSONPointerParseError);
});

specify(
Expand Down
6 changes: 3 additions & 3 deletions test/evaluate/realms/minim.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
JSONPointerIndexError,
JSONPointerTypeError,
JSONPointerKeyError,
JSONPointerEvaluateError,
JSONPointerParseError,
URIFragmentIdentifier,
} from '../../../src/index.js';
import MinimEvaluationRealm from '../../../src/evaluate/realms/minim/index.js';
Expand Down Expand Up @@ -80,10 +80,10 @@ describe('evaluate', function () {
});

context('invalid JSON Pointers (should throw errors)', function () {
specify('should throw JSONPointerEvaluateError for invalid JSON Pointer', function () {
specify('should throw JSONPointerParseError for invalid JSON Pointer', function () {
assert.throws(
() => evaluate(element, 'invalid-pointer', { realm }),
JSONPointerEvaluateError,
JSONPointerParseError,
);
});

Expand Down
13 changes: 7 additions & 6 deletions test/evaluate/trace.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { assert } from 'chai';

import { evaluate, JSONPointerEvaluateError } from '../../src/index.js';
import { evaluate, JSONPointerParseError } from '../../src/index.js';

describe('evaluate', function () {
context('given trace option as object', function () {
Expand Down Expand Up @@ -92,18 +92,19 @@ describe('evaluate', function () {

assert.throws(
() => evaluate({ a: { b: 'c' } }, '1', { trace }),
JSONPointerEvaluateError,
JSONPointerParseError,
'Invalid JSON Pointer: "1". Syntax error at position 0, expected "/"',
);
assert.lengthOf(trace.steps, 1);
// Parse errors occur before evaluation begins, so trace is not populated
assert.notProperty(trace, 'steps');
});
});

context('given trace option as boolean', function () {
specify('should produce error message with tracing info', function () {
assert.throws(
() => evaluate({ a: { b: 'c' } }, '1', { trace: true }),
JSONPointerEvaluateError,
JSONPointerParseError,
'Invalid JSON Pointer: "1". Syntax error at position 0, expected "/"',
);
});
Expand All @@ -112,15 +113,15 @@ describe('evaluate', function () {
specify('should produce error message without tracking info #1', function () {
assert.throws(
() => evaluate({ a: { b: 'c' } }, '1'),
JSONPointerEvaluateError,
JSONPointerParseError,
'Invalid JSON Pointer: "1". Syntax error at position 0',
);
});

specify('should produce error message without tracking info #2', function () {
assert.throws(
() => evaluate({ a: { b: 'c' } }, '1', { trace: false }),
JSONPointerEvaluateError,
JSONPointerParseError,
'Invalid JSON Pointer: "1". Syntax error at position 0',
);
});
Expand Down
Loading