Chore/add typedefs peerstore book template 2 #831

Gozala · 2020-12-10T09:29:25Z

This pull request does following:

Adds aegir from feat: upgrade ts to 4.1.x ipfs/aegir#689 so that new typescript@4.1.x is used
- Which resolves issues with generic class extensions
It addresses bunch of issues that type checker reported
I merged chore: add typedefs #802 into which I think had some fixes that were missing here

@vasco-santos one other thing I want to call out here is that this change turns StreamHandler into non generic, that is because it uses CircuitPB encode / decode which in turn expects concrete structs. I am however not exactly sure I got all the details right, specifically:

According to CircuitRelay protobuf all fields are optional.
But than typedef in chore: add typedefs #802 was defining CircuitRequest with all fields (but code) mandatory.
Writes to StreamHandler seems to always contain code & type
Reads values from StreamHandler are assumed to have type srcPeer, dstPeer.

Which is what were reflected in the StreamHandler API reads return CircuitRequests with all the mandatory fields and writes take CircuitMessages with all the optional fields. However I am guessing that CircuitMessage in fact is more of a union of different message types where each corresponds to Type enum and has different subset of fields & probably each must have some subset of the the fields and that is why protobuf just marks them all optional.

If above hypothesis is correct it would make much more sense to represent each message type via actual type definition with it's fields and represent CircuitMessage as a type union. It would be good to sync up on this to fix those details up.

* feat: auto relay * fix: leverage protoBook events to ask relay peers if they support hop * chore: refactor disconnect * chore: do not listen on a relayed conn * chore: tweaks * chore: improve _listenOnAvailableHopRelays logic * chore: default value of 1 to maxListeners on auto-relay

… manager

Co-authored-by: Jacob Heun <jacobheun@gmail.com>

BREAKING CHANGE: pubsub signing policy properties were changed according to libp2p-interfaces changes to a single property. The emitSelf option default value was also modified to match the routers value

* feat: custom dialer addr sorter * chore: use libp2p utils sorter via addressBook getMultiaddrsForPeer * chore: use new libp2p utils * chore: apply suggestions from code review Co-authored-by: Jacob Heun <jacobheun@gmail.com> Co-authored-by: Jacob Heun <jacobheun@gmail.com>

* 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

* chore: update websockets

Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

vasco-santos · 2020-12-10T11:00:09Z

Added a commit merging in the new updates of the base types branch to check this

vasco-santos · 2020-12-10T11:41:21Z

src/upgrader.js

@@ -231,6 +231,7 @@ class Upgrader {
            const { stream, protocol } = await mss.handle(Array.from(this.protocols.keys()))
            log('%s: incoming stream opened on %s', direction, protocol)
            if (this.metrics) this.metrics.trackStream({ stream, remotePeer, protocol })
+            // @ts-ignore - metadata seems to be required


Fixed on libp2p/js-libp2p-interfaces#74

vasco-santos · 2020-12-10T12:31:00Z

This looks good to me! However, a new issue appeared as a result of this update...

File './node_modules/@types/node/events.d.ts' is not a module.
import { EventEmitter } from "node/events"

This only happens with the new ts. If you look into the dist on libp2p/dist/src/connection-manager/index.d.ts:153:30 you will see the issue with vscode. That is: microsoft/TypeScript#41800 for 4.2.0

vasco-santos · 2020-12-10T12:35:38Z

Which is what were reflected in the StreamHandler API reads return CircuitRequests with all the mandatory fields and writes take CircuitMessages with all the optional fields. However I am guessing that CircuitMessage in fact is more of a union of different message types where each corresponds to Type enum and has different subset of fields & probably each must have some subset of the the fields and that is why protobuf just marks them all optional.

If above hypothesis is correct it would make much more sense to represent each message type via actual type definition with it's fields and represent CircuitMessage as a type union. It would be good to sync up on this to fix those details up.

Yes, this sounds good! I will add it to the follow up list to not block this anymore.
We can follow up with this PR, as well as the list of pending items for the next release

lidel · 2021-04-12T14:36:03Z

Discussion continued in #830

vasco-santos and others added 30 commits November 9, 2020 14:11

chore: auto relay multiaddr update push

8d75093

chore: _isStarted is false when stop starts

971655f

chore: use listening events to create self peer record on updates

ee8ee5b

chore: create signed peer record on new listen addresses in transport…

87d20ac

… manager

chore: add identify test for multiaddr change

abba305

chore: address review

05e6472

chore: lint issue fixed 0.30

2530b83

feat: auto relay network query for new relays

e6b0134

chore: address review

3d2181f

chore: add configuration docs for auto relay and hop service

29e30c2

chore: apply suggestions from code review

2746b4b

Co-authored-by: Jacob Heun <jacobheun@gmail.com>

chore: lint issues fixed

722cacd

chore: sort relay addresses to listen for public first

3bd1768

chore: improve logging for auto relay active listen

558bcf9

chore: store self protocols in protobook (#760)

8456d0e

feat: custom announce filter

0c551d2

chore: remove noAnnounce from address manager

0d1a34b

chore: update address manager readme

10d449a

fix: remove test/dialing/utils extra file

e1ffee1

test: custom announce filter

81c5c43

chore: update pubsub (#801)

bd214d5

BREAKING CHANGE: pubsub signing policy properties were changed according to libp2p-interfaces changes to a single property. The emitSelf option default value was also modified to match the routers value

docs: auto relay example (#795)

b5e38de

* 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

chore: update websockets (#806)

c6fd23a

* chore: update websockets

feat: discover and connect to closest peers (#798)

7c3f7e0

chore: use set-delayed-interval module on circuit (#809)

dbc2653

docs: migration 0.29 to 0.30 (#808)

dfcce96

chore: add typedefs

26c40c8

chore: address review

7e05c4a

Gozala added 2 commits December 10, 2020 01:10

chore: use aegir with ts 4.1.x

ce07544

fix: remaining type errors

7706e39

This was referenced Dec 10, 2020

chore: add typedefs peerstore book template #821

Closed

chore: add typedefs #802

Merged

Gozala requested a review from vasco-santos December 10, 2020 09:35

vasco-santos and others added 3 commits December 10, 2020 11:25

chore: apply suggestions from code review

9966c6c

Co-authored-by: Irakli Gozalishvili <contact@gozala.io>

chore: address other review comments

aa98bc2

chore: merge typedefs newest updates

c4bb3fa

vasco-santos force-pushed the chore/add-typedefs-peerstore-book-template branch 2 times, most recently from 66b9abd to 222bb7b Compare December 10, 2020 11:07

chore: fix lint

e014fee

vasco-santos force-pushed the chore/add-typedefs-peerstore-book-template-2 branch from 671ba33 to e014fee Compare December 10, 2020 11:21

vasco-santos reviewed Dec 10, 2020

View reviewed changes

chore: remove ts ignore from add stream

cba25c8

vasco-santos changed the base branch from chore/add-typedefs-peerstore-book-template to chore/add-typedefs December 10, 2020 11:51

chore: add typedefs (#802)

a279926

vasco-santos changed the base branch from chore/add-typedefs to 0.30.x December 10, 2020 13:48

chore: merge 0.30

2e7f49e

vasco-santos force-pushed the chore/add-typedefs-peerstore-book-template-2 branch from 1d3492f to 2e7f49e Compare December 10, 2020 14:03

vasco-santos mentioned this pull request Dec 10, 2020

Followup: Types #830

Closed

7 tasks

vasco-santos force-pushed the 0.30.x branch from d89b2a0 to 64124f1 Compare December 10, 2020 14:36

vasco-santos mentioned this pull request Dec 10, 2020

feat: upgrade ts to 4.1.x ipfs/aegir#689

Merged

Gozala mentioned this pull request Dec 10, 2020

Track: Typescript types support ipfs/js-ipfs#2945

Closed

Base automatically changed from 0.30.x to master December 16, 2020 12:56

lidel closed this Apr 12, 2021

achingbrain deleted the chore/add-typedefs-peerstore-book-template-2 branch May 18, 2023 13:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Chore/add typedefs peerstore book template 2 #831

Chore/add typedefs peerstore book template 2 #831

Gozala commented Dec 10, 2020

vasco-santos commented Dec 10, 2020

vasco-santos Dec 10, 2020

vasco-santos commented Dec 10, 2020 •

edited

Loading

vasco-santos commented Dec 10, 2020 •

edited

Loading

lidel commented Apr 12, 2021

Chore/add typedefs peerstore book template 2 #831

Chore/add typedefs peerstore book template 2 #831

Conversation

Gozala commented Dec 10, 2020

vasco-santos commented Dec 10, 2020

vasco-santos Dec 10, 2020

Choose a reason for hiding this comment

vasco-santos commented Dec 10, 2020 • edited Loading

vasco-santos commented Dec 10, 2020 • edited Loading

lidel commented Apr 12, 2021

vasco-santos commented Dec 10, 2020 •

edited

Loading

vasco-santos commented Dec 10, 2020 •

edited

Loading