Fix the filter parser

And add a bunch of tests on the filter::from_array
This commit is contained in:
Tamo 2021-10-20 17:27:12 +02:00
parent b6af84eb77
commit 661bc21af5
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69

View File

@ -3,17 +3,19 @@ use std::fmt::Debug;
use std::result::Result as StdResult; use std::result::Result as StdResult;
use nom::branch::alt; use nom::branch::alt;
use nom::bytes::complete::{tag, take_while1}; use nom::bytes::complete::{tag, take_till, take_till1, take_while1};
use nom::character::complete::{char, multispace0}; use nom::character::complete::{char, multispace0};
use nom::combinator::map; use nom::combinator::map;
use nom::error::{ContextError, ErrorKind, VerboseError}; use nom::error::{ContextError, ErrorKind, VerboseError};
use nom::multi::{many0, separated_list1}; use nom::multi::{many0, separated_list1};
use nom::number::complete::recognize_float;
use nom::sequence::{delimited, preceded, tuple}; use nom::sequence::{delimited, preceded, tuple};
use nom::IResult; use nom::IResult;
use self::Operator::*; use self::Operator::*;
use super::FilterCondition; use super::FilterCondition;
use crate::{FieldId, FieldsIdsMap}; use crate::{FieldId, FieldsIdsMap};
#[derive(Debug, Clone, PartialEq)] #[derive(Debug, Clone, PartialEq)]
pub enum Operator { pub enum Operator {
GreaterThan(f64), GreaterThan(f64),
@ -111,28 +113,33 @@ impl<'a> ParseContext<'a> {
where where
E: FilterParserError<'a>, E: FilterParserError<'a>,
{ {
let operator = alt((tag("<="), tag(">="), tag(">"), tag("="), tag("<"), tag("!="))); let operator = alt((tag("<="), tag(">="), tag("!="), tag("<"), tag(">"), tag("=")));
let k = tuple((self.ws(|c| self.parse_key(c)), operator, self.ws(|c| self.parse_key(c))))( let k = tuple((self.ws(|c| self.parse_key(c)), operator, self.ws(|c| self.parse_value(c))))(
input, input,
); );
let (input, (key, op, value)) = match k { let (input, (key, op, value)) = match k {
Ok(o) => o, Ok(o) => o,
Err(e) => { Err(e) => return Err(e),
return Err(e);
}
}; };
let fid = self.parse_fid(input, key)?; let fid = self.parse_fid(input, key)?;
let r: StdResult<f64, nom::Err<VerboseError<&str>>> = self.parse_numeric(value); let r: StdResult<f64, nom::Err<VerboseError<&str>>> = self.parse_numeric(value);
let k = match op { match op {
"=" => FilterCondition::Operator(fid, Equal(r.ok(), value.to_string().to_lowercase())), "=" => {
"!=" => { let k =
FilterCondition::Operator(fid, NotEqual(r.ok(), value.to_string().to_lowercase())) FilterCondition::Operator(fid, Equal(r.ok(), value.to_string().to_lowercase()));
Ok((input, k))
} }
">" | "<" | "<=" | ">=" => return self.parse_numeric_unary_condition(op, fid, value), "!=" => {
let k = FilterCondition::Operator(
fid,
NotEqual(r.ok(), value.to_string().to_lowercase()),
);
Ok((input, k))
}
">" | "<" | "<=" | ">=" => self.parse_numeric_unary_condition(op, fid, value),
_ => unreachable!(), _ => unreachable!(),
}; }
Ok((input, k))
} }
fn parse_numeric<E, T>(&'a self, input: &'a str) -> StdResult<T, nom::Err<E>> fn parse_numeric<E, T>(&'a self, input: &'a str) -> StdResult<T, nom::Err<E>>
@ -142,12 +149,10 @@ impl<'a> ParseContext<'a> {
{ {
match input.parse::<T>() { match input.parse::<T>() {
Ok(n) => Ok(n), Ok(n) => Ok(n),
Err(_) => { Err(_) => match input.chars().nth(0) {
return match input.chars().nth(0) { Some(ch) => Err(nom::Err::Failure(E::from_char(input, ch))),
Some(ch) => Err(nom::Err::Failure(E::from_char(input, ch))), None => Err(nom::Err::Failure(E::from_error_kind(input, ErrorKind::Eof))),
None => Err(nom::Err::Failure(E::from_error_kind(input, ErrorKind::Eof))), },
};
}
} }
} }
@ -194,9 +199,9 @@ impl<'a> ParseContext<'a> {
{ {
let (input, (key, from, _, to)) = tuple(( let (input, (key, from, _, to)) = tuple((
self.ws(|c| self.parse_key(c)), self.ws(|c| self.parse_key(c)),
self.ws(|c| self.parse_key(c)), self.ws(|c| self.parse_value(c)),
tag("TO"), tag("TO"),
self.ws(|c| self.parse_key(c)), self.ws(|c| self.parse_value(c)),
))(input)?; ))(input)?;
let fid = self.parse_fid(input, key)?; let fid = self.parse_fid(input, key)?;
@ -211,22 +216,23 @@ impl<'a> ParseContext<'a> {
where where
E: FilterParserError<'a>, E: FilterParserError<'a>,
{ {
let err_msg_args_incomplete= "_geoRadius. The `_geoRadius` filter expect three arguments: `_geoRadius(latitude, longitude, radius)`"; let err_msg_args_incomplete = "_geoRadius. The `_geoRadius` filter expect three arguments: `_geoRadius(latitude, longitude, radius)`";
let err_msg_latitude_invalid = let err_msg_latitude_invalid =
"_geoRadius. Latitude must be contained between -90 and 90 degrees."; "_geoRadius. Latitude must be contained between -90 and 90 degrees.";
let err_msg_longitude_invalid = let err_msg_longitude_invalid =
"_geoRadius. Longitude must be contained between -180 and 180 degrees."; "_geoRadius. Longitude must be contained between -180 and 180 degrees.";
let (input, args): (&str, Vec<&str>) = match preceded( let parsed = preceded::<_, _, _, E, _, _>(
tag("_geoRadius"), tag("_geoRadius"),
delimited( delimited(
char('('), char('('),
separated_list1(tag(","), self.ws(|c| self.parse_value::<E>(c))), separated_list1(tag(","), self.ws(|c| recognize_float(c))),
char(')'), char(')'),
), ),
)(input) )(input);
{
let (input, args): (&str, Vec<&str>) = match parsed {
Ok(e) => e, Ok(e) => e,
Err(_e) => { Err(_e) => {
return Err(nom::Err::Failure(E::add_context( return Err(nom::Err::Failure(E::add_context(
@ -293,15 +299,30 @@ impl<'a> ParseContext<'a> {
E: FilterParserError<'a>, E: FilterParserError<'a>,
{ {
let key = |input| take_while1(Self::is_key_component)(input); let key = |input| take_while1(Self::is_key_component)(input);
alt((key, delimited(char('"'), key, char('"'))))(input) let simple_quoted_key = |input| take_till(|c: char| c == '\'')(input);
let quoted_key = |input| take_till(|c: char| c == '"')(input);
alt((
delimited(char('\''), simple_quoted_key, char('\'')),
delimited(char('"'), quoted_key, char('"')),
key,
))(input)
} }
fn parse_value<E>(&'a self, input: &'a str) -> IResult<&'a str, &'a str, E> fn parse_value<E>(&'a self, input: &'a str) -> IResult<&'a str, &'a str, E>
where where
E: FilterParserError<'a>, E: FilterParserError<'a>,
{ {
let key = |input| take_while1(Self::is_key_component)(input); let key =
alt((key, delimited(char('"'), key, char('"'))))(input) |input| take_till1(|c: char| c.is_ascii_whitespace() || c == '(' || c == ')')(input);
let simple_quoted_key = |input| take_till(|c: char| c == '\'')(input);
let quoted_key = |input| take_till(|c: char| c == '"')(input);
alt((
delimited(char('\''), simple_quoted_key, char('\'')),
delimited(char('"'), quoted_key, char('"')),
key,
))(input)
} }
fn is_key_component(c: char) -> bool { fn is_key_component(c: char) -> bool {
@ -312,7 +333,7 @@ impl<'a> ParseContext<'a> {
where where
E: FilterParserError<'a>, E: FilterParserError<'a>,
{ {
self.parse_or(input) alt((|input| self.parse_or(input), |input| self.parse_and(input)))(input)
} }
} }
@ -481,6 +502,90 @@ mod tests {
builder.execute(|_, _| ()).unwrap(); builder.execute(|_, _| ()).unwrap();
wtxn.commit().unwrap(); wtxn.commit().unwrap();
// Simple array with Left
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, _, _, &str>(
&rtxn,
&index,
vec![Either::Left(["channel = mv"])],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = mv").unwrap();
assert_eq!(condition, expected);
// Simple array with Right
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, Option<&str>, _, _>(
&rtxn,
&index,
vec![Either::Right("channel = mv")],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = mv").unwrap();
assert_eq!(condition, expected);
// Array with Left and escaped quote
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, _, _, &str>(
&rtxn,
&index,
vec![Either::Left(["channel = \"Mister Mv\""])],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = \"Mister Mv\"").unwrap();
assert_eq!(condition, expected);
// Array with Right and escaped quote
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, Option<&str>, _, _>(
&rtxn,
&index,
vec![Either::Right("channel = \"Mister Mv\"")],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = \"Mister Mv\"").unwrap();
assert_eq!(condition, expected);
// Array with Left and escaped simple quote
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, _, _, &str>(
&rtxn,
&index,
vec![Either::Left(["channel = 'Mister Mv'"])],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = 'Mister Mv'").unwrap();
assert_eq!(condition, expected);
// Array with Right and escaped simple quote
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, Option<&str>, _, _>(
&rtxn,
&index,
vec![Either::Right("channel = 'Mister Mv'")],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "channel = 'Mister Mv'").unwrap();
assert_eq!(condition, expected);
// Simple with parenthesis
let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array::<_, _, _, &str>(
&rtxn,
&index,
vec![Either::Left(["(channel = mv)"])],
)
.unwrap()
.unwrap();
let expected = FilterCondition::from_str(&rtxn, &index, "(channel = mv)").unwrap();
assert_eq!(condition, expected);
// Test that the facet condition is correctly generated. // Test that the facet condition is correctly generated.
let rtxn = index.read_txn().unwrap(); let rtxn = index.read_txn().unwrap();
let condition = FilterCondition::from_array( let condition = FilterCondition::from_array(
@ -501,6 +606,7 @@ mod tests {
.unwrap(); .unwrap();
assert_eq!(condition, expected); assert_eq!(condition, expected);
} }
#[test] #[test]
fn geo_radius() { fn geo_radius() {
let path = tempfile::tempdir().unwrap(); let path = tempfile::tempdir().unwrap();
@ -591,9 +697,11 @@ mod tests {
let result = FilterCondition::from_str(&rtxn, &index, "_geoRadius(-100, 150, 10)"); let result = FilterCondition::from_str(&rtxn, &index, "_geoRadius(-100, 150, 10)");
assert!(result.is_err()); assert!(result.is_err());
let error = result.unwrap_err(); let error = result.unwrap_err();
assert!(error assert!(
.to_string() error.to_string().contains("Latitude must be contained between -90 and 90 degrees."),
.contains("Latitude must be contained between -90 and 90 degrees.")); "{}",
error.to_string()
);
// georadius have a bad latitude // georadius have a bad latitude
let result = FilterCondition::from_str(&rtxn, &index, "_geoRadius(-90.0000001, 150, 10)"); let result = FilterCondition::from_str(&rtxn, &index, "_geoRadius(-90.0000001, 150, 10)");