Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Writable Gateway #9738

Closed
3 tasks done
hacdias opened this issue Mar 20, 2023 · 4 comments · Fixed by #9743
Closed
3 tasks done

Remove Writable Gateway #9738

hacdias opened this issue Mar 20, 2023 · 4 comments · Fixed by #9743
Assignees
Labels
effort/hours Estimated to take one or several hours kind/enhancement A net-new feature or improvement to an existing feature

Comments

@hacdias
Copy link
Member

hacdias commented Mar 20, 2023

Checklist

  • My issue is specific & actionable.
  • I am not suggesting a protocol enhancement.
  • I have searched on the issue tracker for my issue.

Description

We deprecated the writable gateway in 0.19.0 (#9622). I'm creating this issue to track its complete removal so we have less code to maintain and less sources of possible bugs. I vote on removing it in 0.20. It's a relative simple removal. Wdyt? @ipfs/kubo-maintainers

@hacdias hacdias added the kind/enhancement A net-new feature or improvement to an existing feature label Mar 20, 2023
@hacdias hacdias self-assigned this Mar 20, 2023
@hacdias hacdias moved this to 🥞 Todo in IPFS Shipyard Team Mar 20, 2023
@hacdias hacdias added the effort/hours Estimated to take one or several hours label Mar 20, 2023
@BigLep
Copy link
Contributor

BigLep commented Mar 20, 2023

@hacdias : I'm in favor.

@guseggert
Copy link
Contributor

Do we know if there are any users of it?

@lidel
Copy link
Member

lidel commented Mar 20, 2023

The legacy Gateway.Writable is opt-in, so removing it won't be the end of the world, just awkward: it will break existing users without giving them a better replacement any time soon.

It was marked as deprecated to set expectations, so people don't build new things on it while we work on ipfs/specs#375. The plan was to improve onboarding data over HTTP POST, make it useful beyond flat files, support JSON/CBOR, blocks and CARs. Create IPIP spec for it, and replace the legacy writable gateway with better/more comprehensive API

Unfortunately, boxo and the Project Rhea happened, and our timelines/roadmaps changed again and again, but the rationale for ipfs/specs#375 is still valid, and I believe we should get back to it once we are done with Rhea.

@lidel
Copy link
Member

lidel commented Mar 20, 2023

That is to say: I don't know when we will be able to get back to HTTP POST work,
so maybe it is the lesser evil to remove the old API?
Make it so if someone has it enabled, refuse to start and print error pointing them at ipfs/specs#375.

This way users like ipfs/specs#375 (comment) will not be tempted to use legacy API, and be forced to use RPC at /api/v0/add for now.

@hacdias hacdias moved this from 🥞 Todo to 🏃‍♀️ In Progress in IPFS Shipyard Team Mar 21, 2023
@hacdias hacdias moved this from 🏃‍♀️ In Progress to 🔎 In Review in IPFS Shipyard Team Mar 21, 2023
@github-project-automation github-project-automation bot moved this from 🔎 In Review to 🎉 Done in IPFS Shipyard Team Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/hours Estimated to take one or several hours kind/enhancement A net-new feature or improvement to an existing feature
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants