feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} #7930

lidel · 2021-02-19T23:21:22Z

This PR enables Gateways to recover from invalid paths like /ipfs/ipfs/{cid} and redirect them to proper one, when possible.

raison d'être is to

smooth out unforeseen addressing issues during initial adoption, and fix cosmetic mistakes like the value in image tag here (nft) 🐈🏳️‍🌈
make broken URIs resolve in Brave and Opera (because thats where most of people will paste those broken ipfs:// URI to address bar)
provide hint to developers on what should be fixed

cc @autonome

This will try to recover from invalid paths like /ipfs/ipfs/{cid} and redirect to proper one, when possible.

core/corehttp/gateway_handler.go

Stebalien · 2021-02-26T17:47:22Z

This seems weird. This will magically make some invalid URLs "just work". Those invalid URLs will then propagate and become "normal" (requiring support).

Instead of patching go-ipfs to fix URLs like this for people, we should provide clear error messages describing what may/may not have gone wrong.

lidel · 2021-02-26T20:40:51Z

@Stebalien tbh we already have pretty clear error message:
https://dweb.link/ipfs/ipfs/Qmcg8f4F9cig2JWXunxJcdBe58Q5myYXPmGfuMn1TVeswD/nft.mp4
produces:

invalid ipfs path: invalid path "/ipfs/ipfs/Qmcg8f4F9cig2JWXunxJcdBe58Q5myYXPmGfuMn1TVeswD/nft.mp4": invalid CID: selected encoding not supported

I don't think we can make things more clear than "invalid path /ipfs/ipfs".

You have a valid point that silently fixing this == enabling misconfiguration to go unnoticed.
What if we return HTML with error message + redirect after 5seconds?

<!DOCTYPE html><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><meta http-equiv="refresh" content="5;url={intendedURL}" /></head><body>invalid ipfs path: invalid path "{urlPath}": invalid CID: selected encoding not supported</body></html>

This way broken links still load (after a delay) + delay and error are enough signal for dev to fix the address in their NFT contract etc.

Stebalien · 2021-02-26T20:47:59Z

Yeah, that seems reasonable.

This implements error page that does not hide the problem, but still redirects to a valid path after short delay: #7930 (comment)

lidel · 2021-02-26T23:59:45Z

@Stebalien implemented, looks like this (5s was IMO not enough to read the message):

Stebalien · 2021-02-27T00:23:46Z

It may be nicer to replace the entire error message explaining what the issue is, but either way works for me. "/ipfs/ipfs/Qm... should be /ipfs/Qm..." would make more sense than "invalid CID".

core/corehttp/gateway_handler.go

- moved to separate utility function - return Bad Request error - improved escaping of values passed via URL path

#7930 (comment)

core/corehttp/gateway_handler.go

#7930 (comment)

Stebalien

Hm. One more thing.

core/corehttp/gateway_handler.go

This ensures we dont contribute to problem described in: ipfs/kubo#7930

#7930 (comment)

This ensures we dont contribute to problem described in: ipfs/kubo#7930

This implements error page that does not hide the problem, but still redirects to a valid path after short delay: ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@dae7387

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@450baef

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@a35ffee

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@763a120

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} This commit was moved from ipfs/kubo@d30f1e5

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid}

15e3732

This will try to recover from invalid paths like /ipfs/ipfs/{cid} and redirect to proper one, when possible.

lidel added topic/gateway Topic gateway need/review Needs a review labels Feb 19, 2021

lidel requested review from autonome and aschmahmann February 19, 2021 23:21

autonome approved these changes Feb 20, 2021

View reviewed changes

core/corehttp/gateway_handler.go Outdated Show resolved Hide resolved

refactor: show error, delay redirect

dae7387

This implements error page that does not hide the problem, but still redirects to a valid path after short delay: #7930 (comment)

Stebalien requested changes Feb 27, 2021

View reviewed changes

Stebalien added need/author-input Needs input from the original author and removed need/review Needs a review labels Mar 11, 2021

lidel added 2 commits March 18, 2021 21:22

refactor: addressing review

b81b754

- moved to separate utility function - return Bad Request error - improved escaping of values passed via URL path

refactor: explicit prefix check

450baef

#7930 (comment)

lidel requested a review from Stebalien March 18, 2021 20:51

lidel added need/maintainers-input Needs input from the current maintainer(s) and removed need/author-input Needs input from the original author labels Mar 18, 2021

Stebalien approved these changes Mar 18, 2021

View reviewed changes

core/corehttp/gateway_handler.go Outdated Show resolved Hide resolved

Stebalien removed the need/maintainers-input Needs input from the current maintainer(s) label Mar 18, 2021

refactor: safer query handling

a35ffee

#7930 (comment)

Stebalien requested changes Mar 19, 2021

View reviewed changes

core/corehttp/gateway_handler.go Show resolved Hide resolved

lidel added a commit to lidel/minty that referenced this pull request Mar 19, 2021

fix: broken URIs starting with ipfs://ipfs

6233967

This ensures we dont contribute to problem described in: ipfs/kubo#7930

lidel mentioned this pull request Mar 19, 2021

fix: broken URIs starting with ipfs://ipfs yusefnapora/minty#12

Merged

fix: no fixup if X-Ipfs-Gateway-Prefix is present

763a120

#7930 (comment)

lidel requested a review from Stebalien March 24, 2021 19:26

Stebalien approved these changes Mar 24, 2021

View reviewed changes

Stebalien merged commit d30f1e5 into master Mar 24, 2021

Stebalien deleted the fix/redundant-ns-on-gateway branch March 24, 2021 20:12

aschmahmann mentioned this pull request May 14, 2021

Release v0.9.0 #8058

Closed

71 tasks

Forest410 added a commit to Forest410/minty that referenced this pull request Oct 26, 2021

fix: broken URIs starting with ipfs://ipfs

09b1ca5

This ensures we dont contribute to problem described in: ipfs/kubo#7930

Believe-In-Miracles pushed a commit to Believe-In-Miracles/simple-mint that referenced this pull request Jan 30, 2022

fix: broken URIs starting with ipfs://ipfs

d822923

This ensures we dont contribute to problem described in: ipfs/kubo#7930

salahawk added a commit to salahawk/minty that referenced this pull request Feb 16, 2022

fix: broken URIs starting with ipfs://ipfs

8bf3916

This ensures we dont contribute to problem described in: ipfs/kubo#7930

venustar1228 added a commit to venustar1228/minty that referenced this pull request Feb 16, 2022

fix: broken URIs starting with ipfs://ipfs

19b80e2

This ensures we dont contribute to problem described in: ipfs/kubo#7930

lidel mentioned this pull request Feb 25, 2022

Feature request: "web seeding" equivalent functionality? ipfs/ipfs-companion#1049

Open

happyxurde1003 pushed a commit to happyxurde1003/minty that referenced this pull request May 30, 2022

fix: broken URIs starting with ipfs://ipfs

2a951ac

This ensures we dont contribute to problem described in: ipfs/kubo#7930

devninja309 added a commit to devninja309/minty that referenced this pull request Jun 4, 2022

fix: broken URIs starting with ipfs://ipfs

2a37f62

This ensures we dont contribute to problem described in: ipfs/kubo#7930

hacdias pushed a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

refactor: explicit prefix check

9e5f7ba

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@450baef

hacdias pushed a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

refactor: safer query handling

b3e5c1f

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@a35ffee

hacdias pushed a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

fix: no fixup if X-Ipfs-Gateway-Prefix is present

609ddbc

ipfs/kubo#7930 (comment) This commit was moved from ipfs/kubo@763a120

hacdias pushed a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

Merge pull request ipfs/kubo#7930 from ipfs/fix/redundant-ns-on-gateway

dd1f10c

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} This commit was moved from ipfs/kubo@d30f1e5

lidel mentioned this pull request Jan 25, 2024

Gateway: handleSuperfluousNamespace doesn't work with Hostnames ipfs/boxo#344

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} #7930

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} #7930

lidel commented Feb 19, 2021 •

edited

Loading

Stebalien commented Feb 26, 2021

lidel commented Feb 26, 2021 •

edited

Loading

Stebalien commented Feb 26, 2021

lidel commented Feb 26, 2021 •

edited

Loading

Stebalien commented Feb 27, 2021

Stebalien left a comment

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} #7930

feat(gw): /ipfs/ipfs/{cid} → /ipfs/{cid} #7930

Conversation

lidel commented Feb 19, 2021 • edited Loading

Stebalien commented Feb 26, 2021

lidel commented Feb 26, 2021 • edited Loading

Stebalien commented Feb 26, 2021

lidel commented Feb 26, 2021 • edited Loading

Stebalien commented Feb 27, 2021

Stebalien left a comment

Choose a reason for hiding this comment

lidel commented Feb 19, 2021 •

edited

Loading

lidel commented Feb 26, 2021 •

edited

Loading

lidel commented Feb 26, 2021 •

edited

Loading