FuelLabs/sway

Delete redundant spans in `sway_error::error`

Open

#4,818 opened on Jul 18, 2023

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Rust (61,702 stars) (5,421 forks)batch import
ODHack13compilercompiler: uigood first issuemay be rewardedteam:compiler

Description

Now when Idents are used instead of strings, those redundant spans are really annoying and bloating the code.

See this TODO.

When removing those redundant spans we can have a situation that deduplication of error messages might remove errors that are actually not duplicates because although they point to the same Ident (in terms of name), their Spans can be different. Deduplication works on hashes and Ident's hash contains only the name and not the span.

That's why we should always using IdentUnique.

Contributor guide

Tech stack
rust
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rustsway error system basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Remove redundant Span fields in sway error/src/error.rs as per the TODO comment at line 26. Replace with IdentUnique to ensure deduplication uses only the identifier name, not the span. Update all callers and handle any hash based deduplication side effects. Test that identical identifiers with different spans are still deduplicated correctly.