quickwit-oss / quickwit-oss/quickwit

Multi-column types not correctly handled in SortByComponent

Open
#4,703 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Rust
Stars
11.7k
Forks
597
Avg merge
2d 22h
Merged PRs (30d)
37

Description

SortByComponent::FastField { field_name, .. } => {
    let sort_column_opt: Option<(Column<u64>, ColumnType)> =
        segment_reader.fast_fields().u64_lenient(field_name)?; // <-- returns first column it encounters
    let (sort_column, column_type) = sort_column_opt.unwrap_or_else(|| {
        (
            Column::build_empty_column(segment_reader.max_doc()),
            ColumnType::U64,
        )
    });
    let sort_field_type = SortFieldType::try_from(column_type)?;
    Ok(SortingFieldExtractorComponent::FastField {
        sort_column,
        sort_field_type,
    })
}

u64_lenient returns the first column it encounters, but there may be potential multiple types. The order of the columns is defined by their lexicographic ordering of their serialized version in tantivy's columnar storage.

This may lead to unexpected behavior on JSON fields with mixed types. Especially behavior may appear random, depending on what data ends up in which Split.

With search_after we probably want to try to match the colum_type to the parameter passed. Maybe have some priority list of accepted types.

Current ColumnType Order:

#[repr(u8)]
pub enum ColumnType {
    I64 = 0u8,
    U64 = 1u8,
    F64 = 2u8,
    Bytes = 3u8,
    Str = 4u8,
    Bool = 5u8,
    IpAddr = 6u8,
    DateTime = 7u8,
}
Note

This only applies to JSON fields, as only they can have mixed types currently. This includes anything in _dynamic.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the SortByComponent::FastField path and trace how u64_lenient selects a column and how ColumnType becomes SortFieldType. Reproduce the behavior with mixed-type JSON or _dynamic fields, then define and test deterministic type selection that also works with search_after.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
search
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.