mapbox/mapbox-gl-js

getStyle then setStyle broken for raster-dem

Open

#8,506 opened on Jul 18, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (10,532 stars) (2,203 forks)batch import
bug :lady_beetle:good first issue

Description

mapbox-gl-js version: tested on 1.1.0, probably since forever

browser: Chrome 75.0.3770.100 (Official Build) (64-bit)

Steps to Trigger Behavior

  1. setStyle on a style with raster-dem source
  2. getStyle anytime
  3. setStyle with serialized style object from getStyle

Link to Demonstration

https://jsfiddle.net/srmanc/L20ha5um/1/

Expected Behavior

setStyle should work without error msgs

Actual Behavior

setStyle breaks because bounds and url are set on source but are undefined. Sometimes tiles is undefined on source as well. There are actually two issues:

  1. Why does setStyle break at all if some undefined properties are set on source (this only happens for raster-dem type).
  2. When is it acceptable to call getStyle() to get all the relevant properties on sources - they are set initially so there would be no point in not setting them right away - however, tiles property is missing at the first "styledata" event - please review the jsfiddle example with console.log msgs for more input. We can make this work using delete operator but this seems like a nasty bug.

Contributor guide

Tech stack
javascript
Domain
frontend
Issue type
bug
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptMapbox GL JS style spec
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate how raster dem source properties (bounds, url, tiles) are serialized in getStyle and deserialized in setStyle. Look at source/style.js where style methods are defined. Check how tile source properties are set during style loading. Consider using delete operator on undefined properties as a workaround but ensure proper handling in setStyle.