Awesome Endeavour: Circuit Relay

[dryajov]

We're getting close to completing the JS circuit implementation, this issue is to track further progress. Main work is being done here - libp2p/js-libp2p-circuit#9 libp2p/js-libp2p-circuit#14.

Assumptions (needs validation)

1. All addresses are encapsulated with p2p-circuit by default to make them dialable over circuit relay
2. If an explicit relay address is present don't add defaults, use that as the address instead
3. Out of all available transports relay is dialed last

Outstanding work (this will be kept up to date with specific tasks as they come up):

• Complete the relay spec The Circuit Relay Specification: The first iteration libp2p/specs#15
• Verify and complete integration points in js-ipfs and libp2p
  • Finalize integrating with libp2p
  • Finalize integrating with js-ipfs
• More test coverage and integration tests (WIP)
  • this is the latest coverage report for unit tests, lots more is needed but we're getting there

=============================== Coverage summary ===============================
Statements   : 71.03% ( 255/359 )
Branches     : 54.96% ( 72/131 )
Functions    : 70.83% ( 17/24 )
Lines        : 71.23% ( 250/351 )
================================================================================

• Cleanup implementation
  • cleanup pull stream read/write logic
  • cleanup relay.js
  • cleanup listener.js

Outstanding PRs:

Name	Ready for Review	Reviewed	Merged	Published
libp2p-tcp	✅	✅	✅	✅
libp2p-websockets	✅	✅	✅	✅
libp2p-webrtc-star	✅	✅	✅	✅
libp2p-webrtc-direct	✅	✅	✅	✅
libp2p-circuit	✅	✅	✅	✅
libp2p-swarm	✅	✅	✅	✅
libp2p	✅	✅	✅	✅
ipfs	✅	✅	❌	❌

@diasdavid @lgierth @whyrusleeping @dignifiedquire

NOTE: I'm currently bringing this issue up to date with all the latest developments - this is still in WIP.

EDIT: This issue is up to date!

[dryajov]

@diasdavid

Here are the action items discussed last week:

• Clean up libp2p tests
• Add swarm tests
• Work on go-js interop tests
• Prepare demo that showcases circuit
  • Use the files transfer example

[dryajov]

A quick update on whats outstanding:

• mafmt broke with the latest changes for webrtc addresses (mafmt master), I'm working on resolving it. The only address thats broken is the webrtc one, so it isn't really blocking the rest of the effort.
• interop tests in js-ipfs. I've got some basic tests set up in test/core that work, but need to get additional interop tests set up:

test	go-relay	js-relay	notes
go<->go	✅	✅
go<->js-cli	✅	✅
go<->js-browser	✅	✅
js-cli<->go	✅	✅
js-cli<->js-cli	✅	✅
js-cli<->js-browser	❌	✅
js-browser<->go	❌	❌
js-browser<->js-cli	❌	❌
js-browser<->js-browser	✅	✅

EDIT: I'll be adding the missing tests shortly. The reason they are not added yet, is because currently spawning nodes in browser runs is extremely cumbersome. Some of this has been captured in this issue - #1030.

[daviddias]

As an update to everyone following this PR, check @dryajov demoing it on the IPFS All Hands! => https://youtu.be/chAXj_vsR2s?t=25m01s

[daviddias]

This is spawning a ton of go nodes for the interop tests, but interop tests never run this script because they use mocha directly

[dryajov]

True, but interop tests now rely nodes spawned within the tests them self, do we want to rework it in this PR?

[daviddias]

This needs to start using aegir due to https://github.com/ipfs/js-ipfs/pull/830/files#r149579164

[dryajov]

I'll get those in.

[daviddias]

@dignifiedquire is there a way to select custom .aegir.js for different runs? Goal here is to have one for interop and another for unit

[dryajov]

AFAIK, we can have browser.hooks, but not sure if we can have custom tags.

[daviddias]

@dryajov please go ahead and create a PR enabling Circuit Relay interop tests

[daviddias]

The work continues on #1063