mapbox / mapbox/mapbox-gl-js

Improve expression type checking error for "match"

Open
#5,220 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api :memo:
Dominant language
TypeScript
Stars
12.4k
Forks
2.4k
PR merge metrics
No merged PRs in 30d

Description

Using the following expression as a filter (using branch https://github.com/mapbox/mapbox-gl-js/pull/5193 at the time of writing):

```
"filter": {
"expression": [
"curve",
["step"],
["zoom"],
7,
"all",
8,
[
"<", [ "number", [ "get", "area" ] ], 80000
],
9,
[
"<", [ "number", [ "get", "area" ] ], 20000
]
]
}
```

Produces the error, `filter.expression[6]: Expected String but found Boolean instead.`.

Ideally, the error would have been: `filter.expression[4]: Expected Boolean but found String instead`
With perhaps a secondary explanation: `filter expressions must produce Boolean results`
Even better `filter.expression[4]: Expected Boolean but found String literal "all" instead`

(h/t @aparlato @jfirebaugh )

Contributor guide

Open the contributing guide

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 reproducing the reported filter expression and its current error, then trace the expression type-checking path for the "match" case. Done means the diagnostic points to expression index 4, reports the expected Boolean versus the found String literal "all", and may explain that filter expressions must produce Boolean results.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.