mapbox/mapbox-gl-js

validate property names in getPaintProperty

Open

#6,033 opened on Jan 22, 2018

View on GitHub
 (2 comments) (5 reactions) (0 assignees)JavaScript (10,532 stars) (2,203 forks)batch import
api :memo:good first issue

Description

map.setPaintProperty(layer, key value) validates arguments but map.getPaintProperty does not. Providing a bad property key will trigger an internal error. It should trigger an error with a helpful errror message. Seen here: https://github.com/mapbox/mapbox-gl-js/issues/6030

mapbox-gl-js version: v0.43.0 and master

Steps to Trigger Behavior

  1. map.getPaintProperty("background", "fill-radius");

Expected Behavior

something like: "fill-radius" is not a paint property background layers"

Actual Behavior

Uncaught TypeError: Cannot read property 'value' of undefined

Contributor guide

Tech stack
javascript
Domain
api
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptMapbox GL JS basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the implementation of setPaintProperty in the source code (likely in src/ui/map.js) to see how it validates property keys and provides error messages. Then add similar validation to getPaintProperty, following the same pattern. Issue #6030 provides additional context.