ipfs/ipfs-companion

Check API on both ipv4 and ipfv6

Open

#908 opened on Jul 8, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (364 forks)batch import
P3effort/daysexp/experthelp wantedneed/analysisneed/maintainers-input

Repository metrics

Stars
 (1,992 stars)
PR merge metrics
 (Avg merge 53d 3h) (1 merged PR in 30d)

Description

Fun edge case that is super painful to debug:

i had a lingering service bound to: [::1]:8080 (ipv6), so the browser was trying that first. go-ipfs does not bind to that for the gateway so i wasn't getting any feedback ipfs companion could also check for both -- as localhost in the browser will try ipv6 first

Needs more analysis, but initial thoughts:

  • enforce use of raw IP for API port (if it does not yet), convert localhost if needed (removes ambiguity which v is used)
  • support entering API URL as ip4 and ip6 (needs fix for #904)
  • when one fails, try another one, and fixup URL if second one is successful (test with /api/v0/id)

Contributor guide

Research direction
Investigate how the extension currently handles API URL resolution and implement logic to try both IPv4 and IPv6 addresses.
Tech stack
javascript
Domain
frontendapi
Issue type
Feature
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptBrowser extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55