mapbox / mapbox/tilelive

url.parse usage in tilelive.load is unpredicable on windows (remove?)

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
540
Forks
106
PR merge metrics
No merged PRs in 30d

Description

The fallback to `url.parse` at https://github.com/mapbox/tilelive.js/blob/master/lib/tilelive.js#L81 fails hard on windows. Possible to consider removing this and requiring both protocol and pathname to be defined in a uri object?

At least on windows not passing uri as an object, but rather as a string leads to invalid and unpredicatable pathname results:

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 in lib/tilelive.js at the fallback to url.parse around line 81. Reproduce the Windows behavior when a URI is passed as a string, then compare it with a URI object containing protocol and pathname. Done means the URI handling has predictable pathname results on Windows and the intended requirements for protocol and pathname are documented or enforced.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
backend
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.