mirror of https://github.com/meilisearch/MeiliSearch synced 2024-11-16 01:48:56 +01:00

History

Clément Renault 9c1e54a2c8 Move crates under a sub folder to clean up the code		2024-10-21 08:18:43 +02:00
..
fuzz	Move crates under a sub folder to clean up the code	2024-10-21 08:18:43 +02:00
src	Move crates under a sub folder to clean up the code	2024-10-21 08:18:43 +02:00
Cargo.toml	Move crates under a sub folder to clean up the code	2024-10-21 08:18:43 +02:00
README.md	Move crates under a sub folder to clean up the code	2024-10-21 08:18:43 +02:00

README.md

Filter parser

This workspace is dedicated to the parsing of the Meilisearch filters.

Most of the code and explanation are in the lib.rs. Especially, the BNF of the filters at the top of this file.

The parser use nom to do most of its work and nom-locate to keep track of what we were doing when we encountered an error.

Cli

A simple main is provided to quick-test if a filter can be parsed or not without bringing milli. It takes one argument and try to parse it.

cargo run -- 'field = value' # success
cargo run -- 'field = "doggo' # error => missing closing delimiter "

Fuzz

The workspace have been fuzzed with cargo-fuzz.

Setup

You'll need rust-nightly to execute the fuzzer.

cargo install cargo-fuzz

Run

When the filter parser is executed by the fuzzer it's triggering a stackoverflow really fast. We can avoid this problem by limiting the max_len of libfuzzer at 500 characters.

cargo fuzz run parse -- -max_len=500

What to do if you find a bug in the parser

Write a test at the end of the lib.rs to ensure it never happens again.
Add a file in the corpus directory with your filter to help the fuzzer find new bugs. Since this directory is going to be heavily polluted by the execution of the fuzzer it's in the gitignore and you'll need to force push your new test.