linebender / linebender/norad

Plist deserialization: investigate better error reporting

Open
#196 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
61
Forks
16
PR merge metrics
No merged PRs in 30d

Description

I just had someone edit a contents.plist file and forgetting to delete the <value> and the <key>. The returned error was

UnexpectedEventType { expected: ValueOrStartCollection, found: EndCollection }

Not very helpful. norad should take care to bubble up the file in question and ideally the location of the 💥.

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

Reproduce the deserialization failure using the contents.plist case described in the issue, where both and remain. Trace how the UnexpectedEventType error is returned and determine how the affected file and error location can be surfaced. Done means malformed plist input produces a more helpful error identifying the file and, where possible, the failure location.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.