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

Support connecting to the IPFS API via Unix domain sockets #1237

Conversation

AluisioASG
Copy link

Same as ipfs/kubo#6678. I haven't tested it with tracing on, would be nice if someone using that did it.

I'm looking at how to add tests to it.

This is based on similar work done for ipfs at ipfs/kubo#6678.
@welcome
Copy link

welcome bot commented Sep 1, 2020

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

Copy link
Collaborator

@hsanjuan hsanjuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sending this.

I don't think this works. There is a apiURL() method that is used in many places and that does:

fmt.Sprintf("http://%s/api/v0", ipfs.nodeAddr)

and I guess it should instead print something like unix://path-to-socket (?).

About testing, I'd suggest:

  1. Modifying https://github.com/ipfs/ipfs-cluster/blob/master/test/ipfs_mock.go#L135 adding a unixSocketPath string parameter to the function perhaps.
  2. When set, configure the httptest.Server (https://golang.org/pkg/net/http/httptest/#Server) with a unix listener. (Needs to do NewUnstartedServer() first and then Start after replacing the Listener).
  3. Update the function signature wherever is called in the codebase
  4. Add an additional simple test that uses a NewIpfsMock with a unix listener instead of the normal. Make sure that something simple like a call to .ID() works.

All that said, this is a very good idea and glad to support it.

@hsanjuan
Copy link
Collaborator

Closing this as it is stale. Can re-open at a later point.

@hsanjuan hsanjuan closed this Feb 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants