Skip to content

Improve error messages by including the path #356

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 1 commit into
base: master
Choose a base branch
from
Open

Improve error messages by including the path #356

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
24 changes: 14 additions & 10 deletions src/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,38 @@ 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",
"'/{:foo,': Unexpected END at 7, expected }: https://git.new/pathToRegexpError",
),
);
});
it("should throw on nested unbalanced group", () => {
expect(() => parse("/{:foo/{x,y}")).toThrow(
new TypeError(
"Unexpected END at 12, expected }: https://git.new/pathToRegexpError",
"'/{:foo/{x,y}': Unexpected END at 12, expected }: https://git.new/pathToRegexpError",
),
);
});

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 2: https://git.new/pathToRegexpError",
),
);
});

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 2: https://git.new/pathToRegexpError",
),
);
});

it("should throw on unterminated quote", () => {
expect(() => parse('/:"foo')).toThrow(
new TypeError(
"Unterminated quote at 2: https://git.new/pathToRegexpError",
`'/:"foo': Unterminated quote at 2: https://git.new/pathToRegexpError`,
),
);
});
Expand All @@ -58,39 +58,43 @@ describe("path-to-regexp", () => {

expect(() => {
toPath();
}).toThrow(new TypeError("Missing parameters: b"));
}).toThrow(new TypeError("'/a/:b/c': Missing parameters: b"));
});

it("should throw when expecting a repeated value", () => {
const toPath = compile("/*foo");

expect(() => {
toPath({ foo: [] });
}).toThrow(new TypeError('Expected "foo" to be a non-empty array'));
}).toThrow(
new TypeError(`'/*foo': Expected "foo" to be a non-empty array`),
);
});

it("should throw when param gets an array", () => {
const toPath = compile("/:foo");

expect(() => {
toPath({ foo: [] });
}).toThrow(new TypeError('Expected "foo" to be a string'));
}).toThrow(new TypeError(`'/:foo': Expected "foo" to be a string`));
});

it("should throw when a wildcard is not an array", () => {
const toPath = compile("/*foo");

expect(() => {
toPath({ foo: "a" });
}).toThrow(new TypeError('Expected "foo" to be a non-empty array'));
}).toThrow(
new TypeError(`'/*foo': Expected "foo" to be a non-empty array`),
);
});

it("should throw when a wildcard array value is not a string", () => {
const toPath = compile("/*foo");

expect(() => {
toPath({ foo: [1, "a"] as any });
}).toThrow(new TypeError('Expected "foo/0" to be a string'));
}).toThrow(new TypeError(`'/*foo': Expected "foo/0" to be a string`));
});
});

Expand Down
47 changes: 31 additions & 16 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,16 @@ function* lexer(str: string): Generator<LexToken, LexToken> {
}

if (pos) {
throw new TypeError(`Unterminated quote at ${pos}: ${DEBUG_URL}`);
throw new TypeError(
`'${str}': Unterminated quote at ${pos}: ${DEBUG_URL}`,
);
}
}

if (!value) {
throw new TypeError(`Missing parameter name at ${i}: ${DEBUG_URL}`);
throw new TypeError(
`'${str}': Missing parameter name at ${i}: ${DEBUG_URL}`,
);
}

return value;
Expand Down Expand Up @@ -198,12 +202,12 @@ class Iter {
return token.value;
}

consume(type: TokenType): string {
consume(type: TokenType, pathString: string): string {
const value = this.tryConsume(type);
if (value !== undefined) return value;
const { type: nextType, index } = this.peek();
throw new TypeError(
`Unexpected ${nextType} at ${index}, expected ${type}: ${DEBUG_URL}`,
`'${pathString}': Unexpected ${nextType} at ${index}, expected ${type}: ${DEBUG_URL}`,
);
}

Expand Down Expand Up @@ -312,7 +316,7 @@ export function parse(str: string, options: ParseOptions = {}): TokenData {
continue;
}

it.consume(endType);
it.consume(endType, str);
return tokens;
}
}
Expand All @@ -331,14 +335,16 @@ export function compile<P extends ParamData = ParamData>(
const { encode = encodeURIComponent, delimiter = DEFAULT_DELIMITER } =
options;
const data = path instanceof TokenData ? path : parse(path, options);
const fn = tokensToFunction(data.tokens, delimiter, encode);
const fn = tokensToFunction(data.tokens, delimiter, encode, path);

return function path(params: P = {} as P) {
const [path, ...missing] = fn(params);
return function pathFn(params: P = {} as P) {
const [returnPath, ...missing] = fn(params);
if (missing.length) {
throw new TypeError(`Missing parameters: ${missing.join(", ")}`);
throw new TypeError(
`'${stringify(path)}': Missing parameters: ${missing.join(", ")}`,
);
}
return path;
return returnPath;
};
}

Expand All @@ -349,9 +355,10 @@ function tokensToFunction(
tokens: Token[],
delimiter: string,
encode: Encode | false,
path: Path,
) {
const encoders = tokens.map((token) =>
tokenToFunction(token, delimiter, encode),
tokenToFunction(token, delimiter, encode, path),
);

return (data: ParamData) => {
Expand All @@ -374,11 +381,12 @@ function tokenToFunction(
token: Token,
delimiter: string,
encode: Encode | false,
path: Path,
): (data: ParamData) => string[] {
if (token.type === "text") return () => [token.value];

if (token.type === "group") {
const fn = tokensToFunction(token.tokens, delimiter, encode);
const fn = tokensToFunction(token.tokens, delimiter, encode, path);

return (data) => {
const [value, ...missing] = fn(data);
Expand All @@ -395,15 +403,17 @@ function tokenToFunction(
if (value == null) return ["", token.name];

if (!Array.isArray(value) || value.length === 0) {
throw new TypeError(`Expected "${token.name}" to be a non-empty array`);
throw new TypeError(
`'${stringify(path)}': Expected "${token.name}" to be a non-empty array`,
);
}

return [
value
.map((value, index) => {
if (typeof value !== "string") {
throw new TypeError(
`Expected "${token.name}/${index}" to be a string`,
`'${stringify(path)}': Expected "${token.name}/${index}" to be a string`,
);
}

Expand All @@ -419,7 +429,9 @@ function tokenToFunction(
if (value == null) return ["", token.name];

if (typeof value !== "string") {
throw new TypeError(`Expected "${token.name}" to be a string`);
throw new TypeError(
`'${stringify(path)}': Expected "${token.name}" to be a string`,
);
}

return [encodeValue(value)];
Expand Down Expand Up @@ -611,7 +623,10 @@ function negate(delimiter: string, backtrack: string) {
/**
* Stringify token data into a path string.
*/
export function stringify(data: TokenData) {
export function stringify(data: Path) {
if (typeof data === "string") {
return data;
}
return data.tokens
.map(function stringifyToken(token, index, tokens): string {
if (token.type === "text") return escapeText(token.value);
Expand Down