Untagged variants: no warning for patterns shadowed by a literal case, and a spurious non-exhaustive warning for bool payloads
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- ocaml
- Domain
- compilers
Research direction
Start by reading parmatch.ml, which the issue identifies as the site of the exhaustiveness check, and find the adjacent unused-case check for the warning proposal. Review the related issues #8631, #8632, and #8777 for runtime value comparisons and overlap cases. Done means dead untagged payload patterns are warned about and the bool example is exhaustive without an unreachable failure.
Written by the indexing model from the issue text.
Description
Summary
An untagged variant may have a literal case whose runtime value a payload case can also hold (#8632, #8777):
@unboxed type t = | @as("a") A | S(string)
Matching tests declared literals first, so the pattern S("a") can never match. The value "a" always goes to A, or to a wildcard if there is no A arm. The type checker treats S("a") and A as different, which causes two problems.
1. No warning for patterns that can never match
Checked on master. None of these produce a warning, and each S(...) arm marked dead is dead in the generated JS:
let f1 = x => switch x { | A => 1 | S("a") => 2 | S(_) => 3 } // S("a") dead
let f2 = x => switch x { | S("a") => 2 | A => 1 | S(_) => 3 } // dead even as first arm
let f3 = x => switch x { | S("a") => 2 | _ => 3 } // compiles to `return 3`
let f4 = x => switch x { | S("a" | "b") => 2 | _ => 3 } // the "a" alternative is dead
The same applies when:
- the literal comes from the constructor name (
Primary | Color(string):Color("Primary")is dead); - an int literal overlaps a float payload (
@as(1) One | F(float):F(1.0)is dead); - a nested untagged constant has the same value (
@as("x") X | W(inner)whereinnerhas@as("x") P:W(P)is dead).
In a refutable binding such as let l = (S("a") as v) => v, the pattern never matches at all, so every call with S("a") throws Match_failure.
Proposal: warn on a constructor pattern S(p) of an untagged variant when every value p can match is the runtime value of a literal case in the same variant. Use warning 11 (unused case) for a whole arm and warning 12 (redundant sub-pattern) for or-pattern alternatives. Suggested message: "this pattern can never match: "a" is the value of constructor A".
Notes:
- The check is local to each pattern and doesn't depend on arm order, so it can run beside
check_unusedwithout touching the exhaustiveness algorithm. - Values must be compared the way they are at runtime, as in #8631:
1and1.0are equal, bigint spellings differ (1_0n=10n), ints use their 32-bit value, and a constructor without@asis represented by its own name. - Guards (
S(s) if s == "a") are out of scope.
2. Spurious non-exhaustive warning for bool payloads
With #8777 a bool payload can partly overlap a literal:
@unboxed type b = | @as(true) Yes | Ans(bool)
let g = x => switch x { | Yes => 1 | Ans(false) => 2 }
This match covers every value, yet the compiler reports warning 8 with the counterexample Ans(true) and emits an unreachable Match_failure throw. The only way to silence it is to add the dead arm Ans(true) => ..., which point 1 would then flag. The two parts therefore need to land together, or the bool case ends up with no warning-free way to write the match.
Proposal: during the exhaustiveness check only, treat a literal-case pattern as also covering the payload values equal to it, e.g. check Yes as Yes | Ans(true). This is harder than point 1 because it changes parmatch.ml. For string and number payloads it rarely matters, since their domain is infinite, but for bool it does.
Related: #8632, #8777, #8631, rescript-lang/rescript-lang.org#1337
- Dominant language
- ReScript
- Stars
- 7.5k
- Forks
- 483
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 150
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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.
More from rescript-lang/rescript
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
rescript-lang/rescript#8910 ·
Maintainers usually reply within 1 day
-
Nested JSX components under React Server Components: derive flat exports from the signaturePossibly taken @cknitt claimed this 1 day ago. Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
rescript-lang/rescript#8901 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
rescript-lang/rescript#8897 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
rescript-lang/rescript#8878 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
rescript-lang/rescript#8798 ·
Maintainers usually reply within 1 day
All issues in rescript-lang/rescript
Similar issues
-
bug parser
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
swc-project/swc-next#1014 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
swc-project/swc#12576 ·
Maintainers usually reply within 1 day
-
bug priority: P2
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
documentation stdlib
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day