chore: auto relay example #795

vasco-santos · 2020-11-02T14:47:40Z

This PR adds an example to use libp2p's auto relay.

With it, I added a setup to run the examples in CI, inspired by js-ipfs older test setup pre lerna migration ipfs/js-ipfs#2528

Needs:

guidelines for what's next?
tests

jacobheun

Once all the code is updated we should make sure to update the code shown in the readme so it matches properly.

examples/auto-relay/README.md

jacobheun · 2020-11-10T13:52:01Z

examples/auto-relay/README.md

+node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
+```
+
+The Relay HOP advertise functionality is **NOT** required to be enabled. However, if you are interested in advertising on the network that this node is available to be used as a HOP Relay you can enable it.


The problem with this example is that the node has no way of actually advertising. A content router has to be included for this to work. I would disable it for this example and mention here that a router is required. Ideally this should link to available routers so we can just update that section with Rendezvous is ready.

examples/auto-relay/README.md

jacobheun · 2020-11-10T13:54:30Z

examples/auto-relay/README.md

+/ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3
+```
+
+TODO: Docker Image with a repo


What's this for?

I think we should create a simple Docker Image with relay and HOP enabled to enable people to easily deploy Relays. I will remove this from now, while I think in the best solution to also include the announce addresses logic

jacobheun · 2020-11-10T16:27:57Z

examples/auto-relay/README.md

+Node started: QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm
+connected to the HOP relay
+Listening on:
+/ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3/p2p-circuit/p2p/QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm


Consider cleaning the logging up a bit to be a bit clearer, something like:

Suggested change

Node started: QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm

connected to the HOP relay

Listening on:

/ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3/p2p-circuit/p2p/QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm

Node started with id QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm

Connected to the HOP relay QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3

Advertising with a relay address of /ip4/192.168.1.120/tcp/61592/ws/p2p/QmWDn2LY8nannvSWJzruUYoLZ4vV83vfCBwd8DipvdgQc3/p2p-circuit/p2p/QmerrWofKF358JE6gv3z74cEAyL7z1KqhuUoVfGEynqjRm

jacobheun · 2020-11-10T16:33:07Z

examples/auto-relay/auto-relay.js

+  await node.dial(relayAddr)
+
+  // Wait for connection and relay to be bind for the example purpose
+  await pWaitFor(() => node.multiaddrs.length > 0)


Instead of pWaitFor perhaps it would be best to listen on the Peer Store for our own address change. This also ensures we're only using libp2p deps in this example.

jacobheun · 2020-11-10T16:34:30Z

examples/auto-relay/auto-relay.js

+  console.log('connected to the HOP relay')
+  console.log('Listening on:')
+  node.multiaddrs.forEach((ma) => console.log(`${ma.toString()}/p2p/${node.peerId.toB58String()}`))
+})()


nit: instead of a self executing anonymous function it might be helpful to put these in a function like main and then execute that. Same for the other files.

jacobheun · 2020-11-10T16:36:47Z

examples/auto-relay/other-node.js

@@ -0,0 +1,27 @@
+'use strict'


Instead of other-node perhaps we should use the same format as other examples: dialer, listener?

jacobheun · 2020-11-10T16:37:41Z

examples/auto-relay/relay.js

+    },
+    addresses: {
+      listen: ['/ip4/0.0.0.0/tcp/0/ws']
+      // announceFilter: TODO check production section


What production section?

Changed, it was the What's next section where I mention that the announceAddrs should be changed for production

jacobheun · 2020-11-16T14:26:07Z

examples/auto-relay/listener.js

+    node.peerStore.on('change:multiaddrs', ({ peerId }) => {
+      // Updated self multiaddrs?
+      if (peerId.equals(node.peerId)) {
+        resolve()


Maybe get rid of the promise logic and just put the console logs here? This event listener never gets cleaned up and can throw an error if our addresses change again and call resolve on the already resolved promise.

yes, that makes a lot of sense! thanks

jacobheun

LGTM

* chore: auto relay example * chore: update examples to use process arguments * chore: add test setup for node tests and test for auto-relay * chore: apply suggestions from code review * chore: do not use promise for multiaddrs event on example

vasco-santos force-pushed the chore/auto-relay-example branch 4 times, most recently from 65a7aaf to dfceafb Compare November 5, 2020 14:49

vasco-santos marked this pull request as ready for review November 6, 2020 15:52

vasco-santos requested a review from jacobheun November 6, 2020 15:52

vasco-santos force-pushed the 0.30.x branch from c9e6757 to 8456d0e Compare November 9, 2020 13:20

vasco-santos force-pushed the chore/auto-relay-example branch 2 times, most recently from 0f68e5d to 6850cd2 Compare November 9, 2020 14:11

vasco-santos added 3 commits November 10, 2020 09:38

chore: auto relay example

43b7afa

chore: update examples to use process arguments

2bd1a2f

chore: add test setup for node tests and test for auto-relay

a09ac4a

vasco-santos force-pushed the chore/auto-relay-example branch from 6850cd2 to a09ac4a Compare November 10, 2020 08:45

jacobheun reviewed Nov 10, 2020

View reviewed changes

chore: apply suggestions from code review

5623449

vasco-santos force-pushed the chore/auto-relay-example branch from a0f305c to 5623449 Compare November 12, 2020 12:54

vasco-santos requested a review from jacobheun November 12, 2020 13:34

jacobheun reviewed Nov 16, 2020

View reviewed changes

chore: do not use promise for multiaddrs event on example

05bdb1f

vasco-santos requested a review from jacobheun November 16, 2020 15:41

jacobheun approved these changes Nov 20, 2020

View reviewed changes

jacobheun merged commit b5e38de into 0.30.x Nov 20, 2020

jacobheun deleted the chore/auto-relay-example branch November 20, 2020 14:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: auto relay example #795

chore: auto relay example #795

vasco-santos commented Nov 2, 2020 •

edited

Loading

jacobheun left a comment

jacobheun Nov 10, 2020

jacobheun Nov 10, 2020

vasco-santos Nov 12, 2020

jacobheun Nov 10, 2020

jacobheun Nov 10, 2020

jacobheun Nov 10, 2020

jacobheun Nov 10, 2020

jacobheun Nov 10, 2020

vasco-santos Nov 12, 2020

jacobheun Nov 16, 2020

vasco-santos Nov 16, 2020

jacobheun left a comment

chore: auto relay example #795

chore: auto relay example #795

Conversation

vasco-santos commented Nov 2, 2020 • edited Loading

jacobheun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

vasco-santos commented Nov 2, 2020 •

edited

Loading