quickwit-oss / quickwit-oss/quickwit

Usage of Path::join creates non-conform index on windows

Open
#118 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug
On MS Windows 10, since the standard path separator is \, usage of Path::join creates indices that cannot be found on other nix* platforms.
Step to reproduce:

Steps to reproduce (if applicable)
Steps to reproduce the behavior:

  1. Run cargo run -- new --index-uri s3://quickwit-dev/evance/data --no-timestamp-field --doc-mapper-type wikipedia
  2. An index is create on s3 at: s3://quickwit-dev/evance\data\quickwit.json
  3. Trying to access this index via any other command on macos or ubuntu will yield IndexNotFound error.

Expected behavior
Index manipulation should be interoperable across all platforms we support

System configuration:
Windows 10,
Rustup 1.24.3 31/05/2021
Rustc 1.52.1 09/05/2021

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 with the cargo run -- new reproduction command and trace where the index URI is constructed with Path::join. Verify the generated S3 index path on Windows and a Unix-like platform, then confirm that an index created on one supported platform can be opened from another.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cloud, search
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.