mapbox/mapbox-gl-js

Stack not preserved in ajax.js

Open

#11,824 opened on Apr 25, 2022

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: 2.3.0, 2.8.1, etc

browser: Chrome etc

Steps to Trigger Behavior

  1. Somehow get an error with a puzzling message which hits https://github.com/mapbox/mapbox-gl-js/blob/main/src/util/ajax.js#L182 if (!aborted) callback(new Error(err.message));
  2. Notice that the new error discards the stack which makes figuring out the error difficult

Link to Demonstration

In my case the error showed up in tracking, and the repro steps are unclear. Hence, a stack trace would really help. The error message itself is Error: Cannot read properties of undefined (reading 'send') which is hard to debug, and it could be our bug, a mapbox bug, or anything else. So preserving the stack trace somehow or other would be useful to debug what is happening.

Obviously, stack preservation anywhere else errors are wrapped like this would be useful.

Expected Behavior

The error has a convenient stack trace from the original error

Actual Behavior

It does not

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.
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
basic JavaScript error handlingfamiliarity with ajax.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is in src/util/ajax.js around line 182 where a new Error is created without preserving the original stack. Look at how errors are wrapped in that function and consider using a library like 'verror' or manually copying the stack property. The PR #11825 or similar may have relevant discussion.