theupdateframework / theupdateframework/rust-tuf
Merge MetadataPath/TargetPath/VirtualTargetPath?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 198
- Forks
- 39
- Avg merge
- 9h 19m
- Merged PRs (30d)
- 2
Description
I don't really see a strong distinction between MetadataPath and TargetPath, and I'm not sure if VirtualTargetPath ought to be exposed to the user. It feels more like a Repository implementation detail. Is there some subtly here that I'm missing? It feels like it could be easy to accidentally use a real path like foo/bar when something expected a virtual path like foo-bar. It also seems like it'd be pretty easy for users to use the wrong PathTranslator and really confusing the repositories.
If we do merge these types, as an added benefit I think this would let us clean up the Client interface and drop the generic PathTranslator trait bound.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the definitions and usages of MetadataPath, TargetPath, and VirtualTargetPath, then trace how Repository and Client use PathTranslator. Determine whether real and virtual paths can share one safe abstraction and whether the generic Client bound can be removed. Done requires a documented design decision and agreement on the affected public API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100