Skip to content

Add original path to error messages #363

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

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

Add original path to error messages #363

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3f25805
Add original path to error messages
blakeembrey May 10, 2025
98246be
Add more test coverage for error message
blakeembrey May 10, 2025
2962bc0
Update error message
blakeembrey Jul 31, 2025
c810cd9
Reduce stack size for errors
blakeembrey Jul 31, 2025
35ff289
Test coverage for array
blakeembrey Jul 31, 2025
1bc7e96
Remove another function in stack
blakeembrey Jul 31, 2025
85e5e2c
Prune some bytes
blakeembrey Jul 31, 2025
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
124 changes: 88 additions & 36 deletions src/cases.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
type CompileOptions,
type ParamData,
TokenData,
Path,
} from "./index.js";

export interface ParserTestSet {
Expand All @@ -21,7 +22,7 @@ export interface StringifyTestSet {
}

export interface CompileTestSet {
path: string;
path: Path;
options?: CompileOptions & ParseOptions;
tests: Array<{
input: ParamData | undefined;
Expand All @@ -30,7 +31,7 @@ export interface CompileTestSet {
}

export interface MatchTestSet {
path: string;
path: Path | Path[];
options?: MatchOptions & ParseOptions;
tests: Array<{
input: string;
Expand All @@ -41,64 +42,99 @@ export interface MatchTestSet {
export const PARSER_TESTS: ParserTestSet[] = [
{
path: "/",
expected: new TokenData([{ type: "text", value: "/" }]),
expected: new TokenData([{ type: "text", value: "/" }], "/"),
},
{
path: "/:test",
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "test" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "test" },
],
"/:test",
),
},
{
path: "/:a:b",
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "a" },
{ type: "param", name: "b" },
],
"/:a:b",
),
},
{
path: '/:"0"',
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "0" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "0" },
],
'/:"0"',
),
},
{
path: "/:_",
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "_" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "_" },
],
"/:_",
),
},
{
path: "/:café",
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "café" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "café" },
],
"/:café",
),
},
{
path: '/:"123"',
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "123" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "123" },
],
'/:"123"',
),
},
{
path: '/:"1\\"\\2\\"3"',
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: '1"2"3' },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: '1"2"3' },
],
'/:"1\\"\\2\\"3"',
),
},
{
path: "/*path",
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "wildcard", name: "path" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "wildcard", name: "path" },
],
"/*path",
),
},
{
path: '/:"test"stuff',
expected: new TokenData([
{ type: "text", value: "/" },
{ type: "param", name: "test" },
{ type: "text", value: "stuff" },
]),
expected: new TokenData(
[
{ type: "text", value: "/" },
{ type: "param", name: "test" },
{ type: "text", value: "stuff" },
],
'/:"test"stuff',
),
},
];

Expand Down Expand Up @@ -1609,4 +1645,20 @@ export const MATCH_TESTS: MatchTestSet[] = [
},
],
},

/**
* Array input is normalized.
*/
{
path: ["/:foo/:bar", "/:foo/:baz"],
tests: [
{
input: "/hello/world",
expected: {
path: "/hello/world",
params: { foo: "hello", bar: "world" },
},
},
],
},
];
77 changes: 71 additions & 6 deletions src/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import { describe, it, expect } from "vitest";
import { parse, compile, match, stringify } from "./index.js";
import {
parse,
compile,
match,
stringify,
pathToRegexp,
TokenData,
} from "./index.js";
import {
PARSER_TESTS,
COMPILE_TESTS,
Expand All @@ -15,38 +22,39 @@ describe("path-to-regexp", () => {
it("should throw on unbalanced group", () => {
expect(() => parse("/{:foo,")).toThrow(
new TypeError(
"Unexpected END at 7, expected }: https://git.new/pathToRegexpError",
"Unexpected END at index 7, expected }: /{:foo,; visit https://git.new/pathToRegexpError for info",
),
);
});

it("should throw on nested unbalanced group", () => {
expect(() => parse("/{:foo/{x,y}")).toThrow(
new TypeError(
"Unexpected END at 12, expected }: https://git.new/pathToRegexpError",
"Unexpected END at index 12, expected }: /{:foo/{x,y}; visit https://git.new/pathToRegexpError for info",
),
);
});

it("should throw on missing param name", () => {
expect(() => parse("/:/")).toThrow(
new TypeError(
"Missing parameter name at 2: https://git.new/pathToRegexpError",
"Missing parameter name at index 2: /:/; visit https://git.new/pathToRegexpError for info",
),
);
});

it("should throw on missing wildcard name", () => {
expect(() => parse("/*/")).toThrow(
new TypeError(
"Missing parameter name at 2: https://git.new/pathToRegexpError",
"Missing parameter name at index 2: /*/; visit https://git.new/pathToRegexpError for info",
),
);
});

it("should throw on unterminated quote", () => {
expect(() => parse('/:"foo')).toThrow(
new TypeError(
"Unterminated quote at 2: https://git.new/pathToRegexpError",
'Unterminated quote at index 2: /:"foo; visit https://git.new/pathToRegexpError for info',
),
);
});
Expand Down Expand Up @@ -94,6 +102,63 @@ describe("path-to-regexp", () => {
});
});

describe("pathToRegexp errors", () => {
it("should throw when missing text between params", () => {
expect(() => pathToRegexp("/:foo:bar")).toThrow(
new TypeError(
'Missing text before "bar": /:foo:bar; visit https://git.new/pathToRegexpError for info',
),
);
});

it("should throw when missing text between params using TokenData", () => {
expect(() =>
pathToRegexp(
new TokenData([
{ type: "param", name: "a" },
{ type: "param", name: "b" },
]),
),
).toThrow(
new TypeError(
'Missing text before "b"; visit https://git.new/pathToRegexpError for info',
),
);
});

it("should throw with `originalPath` when missing text between params using TokenData", () => {
expect(() =>
pathToRegexp(
new TokenData(
[
{ type: "param", name: "a" },
{ type: "param", name: "b" },
],
"/[a][b]",
),
),
).toThrow(
new TypeError(
'Missing text before "b": /[a][b]; visit https://git.new/pathToRegexpError for info',
),
);
});

it("should contain the error line", () => {
expect.hasAssertions();

try {
pathToRegexp("/:");
} catch (error) {
const stack = (error as Error).stack
?.split("\n")
.slice(0, 6)
.join("\n");
expect(stack).toContain("index.spec.ts");
}
});
});

describe.each(PARSER_TESTS)(
"parse $path with $options",
({ path, options, expected }) => {
Expand Down
Loading