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.

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

Better error messages for truncated files #1050

Merged
merged 2 commits into from
May 17, 2024
Merged
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
47 changes: 34 additions & 13 deletions askama_parser/src/node.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use nom::error_position;
use nom::multi::{fold_many0, many0, many1, separated_list0, separated_list1};
use nom::sequence::{delimited, pair, preceded, terminated, tuple};

use crate::{not_ws, ErrorContext, ParseResult};
use crate::{not_ws, ErrorContext, ParseErr, ParseResult};

use super::{
bool_lit, char_lit, filter, identifier, is_ws, keyword, num_lit, path_or_identifier, skip_till,
Expand Down Expand Up @@ -93,10 +93,16 @@ impl<'a> Node<'a> {
let (i, _) = s.nest(j)?;
let result = func(i, s);
s.leave();

let (i, node) = result?;
let (i, _) = cut(|i| s.tag_block_end(i))(i)?;
Ok((i, node))

let (i, closed) = cut(alt((
value(true, |i| s.tag_block_end(i)),
value(false, ws(eof)),
)))(i)?;
match closed {
true => Ok((i, node)),
false => Err(fail_unclosed("block", s.syntax.block_end, i)),
}
}

fn r#break(i: &'a str, s: &State<'_>) -> ParseResult<'a, Self> {
Expand Down Expand Up @@ -132,17 +138,22 @@ impl<'a> Node<'a> {
}

fn expr(i: &'a str, s: &State<'_>) -> ParseResult<'a, Self> {
let mut p = tuple((
let (i, (pws, expr)) = preceded(
|i| s.tag_expr_start(i),
cut(tuple((
cut(pair(
opt(Whitespace::parse),
ws(|i| Expr::parse(i, s.level.get())),
opt(Whitespace::parse),
|i| s.tag_expr_end(i),
))),
));
let (i, (_, (pws, expr, nws, _))) = p(i)?;
Ok((i, Self::Expr(Ws(pws, nws), expr)))
)),
)(i)?;

let (i, (nws, closed)) = cut(pair(
opt(Whitespace::parse),
alt((value(true, |i| s.tag_expr_end(i)), value(false, ws(eof)))),
))(i)?;
match closed {
true => Ok((i, Self::Expr(Ws(pws, nws), expr))),
false => Err(fail_unclosed("expression", s.syntax.expr_end, i)),
}
}
}

Expand Down Expand Up @@ -1059,7 +1070,10 @@ impl<'a> Comment<'a> {
fn content<'a>(mut i: &'a str, s: &State<'_>) -> ParseResult<'a, ()> {
let mut depth = 0usize;
loop {
let (_, (j, tag)) = skip_till(|i| tag(i, s))(i)?;
let (_, tag) = opt(skip_till(|i| tag(i, s)))(i)?;
let Some((j, tag)) = tag else {
return Err(fail_unclosed("comment", s.syntax.comment_end, i));
};
match tag {
Tag::Open => match depth.checked_add(1) {
Some(new_depth) => depth = new_depth,
Expand Down Expand Up @@ -1109,3 +1123,10 @@ impl<'a> Comment<'a> {
/// Second field is "minus/plus sign was used on the right part of the item".
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Ws(pub Option<Whitespace>, pub Option<Whitespace>);

fn fail_unclosed<'a>(kind: &str, tag: &str, i: &'a str) -> ParseErr<'a> {
nom::Err::Failure(ErrorContext {
input: i,
message: Some(Cow::Owned(format!("unclosed {kind}, missing {tag:?}"))),
})
}
51 changes: 51 additions & 0 deletions testing/tests/ui/unclosed-nodes.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
use askama::Template;

#[derive(Template)]
#[template(source = "{{ expr", ext = "txt")]
struct Expr1;

#[derive(Template)]
#[template(source = "{{ expr ", ext = "txt")]
struct Expr2;

#[derive(Template)]
#[template(source = "{{ expr -", ext = "txt")]
struct Expr3;

#[derive(Template)]
#[template(source = "{{ expr -}", ext = "txt")]
struct Expr4;

#[derive(Template)]
#[template(source = "{% let x", ext = "txt")]
struct Node1;

#[derive(Template)]
#[template(source = "{% let x ", ext = "txt")]
struct Node2;

#[derive(Template)]
#[template(source = "{% let x -", ext = "txt")]
struct Node3;

#[derive(Template)]
#[template(source = "{% let x -%", ext = "txt")]
struct Node4;

#[derive(Template)]
#[template(source = "{# comment", ext = "txt")]
struct Comment1;

#[derive(Template)]
#[template(source = "{# comment ", ext = "txt")]
struct Comment2;

#[derive(Template)]
#[template(source = "{# comment -", ext = "txt")]
struct Comment3;

#[derive(Template)]
#[template(source = "{# comment -#", ext = "txt")]
struct Comment4;

fn main() {}
117 changes: 117 additions & 0 deletions testing/tests/ui/unclosed-nodes.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
error: unclosed expression, missing "}}"
failed to parse template source at row 1, column 7 near:
""
--> tests/ui/unclosed-nodes.rs:3:10
|
3 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed expression, missing "}}"
failed to parse template source at row 1, column 8 near:
""
--> tests/ui/unclosed-nodes.rs:7:10
|
7 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed expression, missing "}}"
failed to parse template source at row 1, column 9 near:
""
--> tests/ui/unclosed-nodes.rs:11:10
|
11 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: failed to parse template source at row 1, column 9 near:
"}"
--> tests/ui/unclosed-nodes.rs:15:10
|
15 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed block, missing "%}"
failed to parse template source at row 1, column 8 near:
""
--> tests/ui/unclosed-nodes.rs:19:10
|
19 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed block, missing "%}"
failed to parse template source at row 1, column 9 near:
""
--> tests/ui/unclosed-nodes.rs:23:10
|
23 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed block, missing "%}"
failed to parse template source at row 1, column 10 near:
""
--> tests/ui/unclosed-nodes.rs:27:10
|
27 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: failed to parse template source at row 1, column 10 near:
"%"
--> tests/ui/unclosed-nodes.rs:31:10
|
31 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed comment, missing "#}"
failed to parse template source at row 1, column 2 near:
" comment"
--> tests/ui/unclosed-nodes.rs:35:10
|
35 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed comment, missing "#}"
failed to parse template source at row 1, column 2 near:
" comment "
--> tests/ui/unclosed-nodes.rs:39:10
|
39 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed comment, missing "#}"
failed to parse template source at row 1, column 2 near:
" comment -"
--> tests/ui/unclosed-nodes.rs:43:10
|
43 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)

error: unclosed comment, missing "#}"
failed to parse template source at row 1, column 2 near:
" comment -#"
--> tests/ui/unclosed-nodes.rs:47:10
|
47 | #[derive(Template)]
| ^^^^^^^^
|
= note: this error originates in the derive macro `Template` (in Nightly builds, run with -Z macro-backtrace for more info)