composefs / composefs/composefs-rs

Improve error reporting

Open
#110 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Rust
Stars
93
Forks
30
Avg merge
2d 10h
Merged PRs (30d)
13

Description

Error reporting right now is pretty sub optimal which makes tracking down the exact source pretty cumbersome. Case in point, the following error

Error: Directory entry "grpc" does not exist

is caused by

    #[error("Directory entry {0:?} does not exist")]
    NotFound(Box<OsStr>),

The above error value is used in multiple places, six to be exact, which demands checking all of said places.

We should use fn_error_context::context to have additional information on the error source.

Contributor guide

No contributing guide indexed for this repository

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 by locating the NotFound error definition and its six call sites, then read how fn_error_context::context is used in the surrounding error paths. Add enough context for the reported directory-entry failure to identify its source, and verify that the resulting errors are more specific.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
operating-systems
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.