feat!: convert to typescript #151

vogdb · 2022-03-09T08:48:35Z

The PR is not ready for a merge. I've pushed it to ask some questions. The questions are posted as comments at the relevant source lines.

package.json

vogdb · 2022-03-09T08:51:34Z

src/socket-to-conn.ts

@@ -49,11 +63,11 @@ module.exports = (socket, options = {}) => {
      : undefined,

    // If the remote address was passed, use it - it may have the peer ID encapsulated
-    remoteAddr: options.remoteAddr,
+    remoteAddr: options.remoteAddr ?? toMultiaddr(socket.remoteAddress ?? '', socket.remotePort ?? ''),


I had to add this conversion because remoteAddr is required in MultiaddrConnection interface.

Maybe we should just throw if options.remoteAddr or socket.remoteAddress or socket.remotePort is nullish. Having a blank multiaddr or ill-formed multiaddr is not useful here.

I made remoteAddr option mandatory because all usages of ToConnectionOptions specify it. Please verify.

vogdb · 2022-03-09T08:52:56Z

src/listener.ts

+    })
+
+    const maConn = toMultiaddrConnection(channel, {
+      remoteAddr: ipPortToMultiaddr(req.socket.remoteAddress, req.socket.remotePort)


Should we throw when req.socket.remoteAddress is undefined? It can be, according to the docs https://nodejs.org/api/net.html#class-netsocket

I'm not sure if it's necessary or if its just used for diagnostics, @vasco-santos any thoughts?

I made remoteAddr option mandatory because all usages of ToConnectionOptions specify it. Please verify.

vogdb · 2022-03-09T08:57:22Z

src/index.ts

+const log = logger('libp2p:webrtcdirect')
+
+export interface WebRTCDirectListenerOptions extends ListenerOptions{
+  channelOptions?: Object


I followed the same logic as in js-libp2p-webrtc-star/webrtc-star-transport. However I didn't describe the type of channelOptions. As far as this code is concerned, Object type looked fine but let me know if you want to describe it thoroughly.

It would be better to describe the shape entirely, not use Object type.

Please look. The exact shape is described here https://www.npmjs.com/package/libp2p-webrtc-peer#api. See constructor options:

{ initiator: false, channelConfig: {}, channelName: '<random string>', config: { iceServers: [{ urls: 'stun:stun.l.google.com:19302' }, { urls: 'stun:global.stun.twilio.com:3478?transport=udp' }] }, offerOptions: {}, answerOptions: {}, sdpTransform: function (sdp) { return sdp }, stream: false, streams: [], trickle: true, allowHalfTrickle: false, wrtc: {}, // RTCPeerConnection/RTCSessionDescription/RTCIceCandidate objectMode: false }

I described all the keys of this object. However for config key I used a plain object. Do you want me to describe it more rigid with iceServers and urls?

src/index.ts

vogdb · 2022-03-14T07:14:05Z

@vasco-santos @wemeetagain , please look when you have a minute.

- make `ToConnectionOptions` mandatory in `toMultiaddrConnection` - make `remoteAddr` mandatory in `ToConnectionOptions`

- Update code to use interfaces from `@libp2p/interfaces` - Update module name to use the `@libp2p/` scope - Use the same `@libp2p/webrtc-peer` module as `@libp2p/webrtc-star` - Update licenses, CI and project config to match other `@libp2p/` modules BREAKING CHANGE: this module now only exports named exports and is ESM only

achingbrain · 2022-03-25T16:02:17Z

I've updated this PR to use the new @libp2p/* typescript modules, including the @libp2p/webrtc-peer module that is used by @libp2p/webrtc-star - this is the bits of simple-peer that we use ported to typescript - e.g. it's just a one-to-one RTC data channel without support for audio or video since we don't use that.

It also has auto-release now, should be all set up to go.

achingbrain · 2022-03-25T16:21:32Z

GH actions is being really flaky today, only seems to run on about 1/2 of the commits.

mpetrunic

lgtm

## [1.0.0](v0.7.1...v1.0.0) (2022-03-28) ### ⚠ BREAKING CHANGES * this module is now ESM-only Co-authored-by: achingbrain <alex@achingbrain.net> ### Features * convert to typescript ([#151](#151)) ([85ce5cf](85ce5cf)) ### Bug Fixes * add 'node-pre-gyp' installation to 'check' and 'test-node' actions ([#152](#152)) ([bf4a68b](bf4a68b)) ### Trivial Changes * add note about `node-pre-gyp` to readme.md ([#141](#141)) ([ab4cc82](ab4cc82)), closes [#140](#140) * **deps-dev:** bump aegir from 35.2.1 to 36.0.0 ([#139](#139)) ([720cfad](720cfad)) * replace Travis with Github Actions ([#150](#150)) ([a73735b](a73735b)) * update project config ([13ab340](13ab340)) * update Readme ([#148](#148)) ([ba9facb](ba9facb))

github-actions · 2022-03-28T10:36:42Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

vogdb commented Mar 9, 2022

View reviewed changes

package.json Show resolved Hide resolved

vogdb commented Mar 9, 2022

View reviewed changes

package.json Show resolved Hide resolved

vogdb commented Mar 9, 2022

View reviewed changes

src/index.ts Outdated Show resolved Hide resolved

vasco-santos requested a review from wemeetagain March 14, 2022 08:45

vogdb added 4 commits March 15, 2022 15:19

feat: convert to typescript

f4f1b58

introduce WebRTCDirectDialOptions

c60d910

mandatory options

734f8f4

- make `ToConnectionOptions` mandatory in `toMultiaddrConnection` - make `remoteAddr` mandatory in `ToConnectionOptions`

Rename channelOptions to peerOptions. Describe it thoroughly.

c9a7d2b

vogdb force-pushed the typescript branch from d1ad1f7 to c9a7d2b Compare March 16, 2022 12:08

BigLep assigned achingbrain Mar 18, 2022

BigLep mentioned this pull request Mar 18, 2022

[Tracker] js-libp2p getting full Type Script support libp2p/js-libp2p#1021

Closed

43 tasks

achingbrain added 5 commits March 19, 2022 11:44

chore: catch stream errors

48fd4d9

chore: remove main

81ac205

chore: update release scripts

7e47e26

chore: catch more errors when we close streams we are not interested in

9238fdd

vogdb mentioned this pull request Mar 20, 2022

Use semantic-release for releasing #153

Closed

achingbrain added 9 commits March 20, 2022 09:13

fix: remove catches from tests

0b20efe

chore: implement skipped tests

fa366bf

chore: update published files

e280645

chore: slow ci is slow

fd9b93e

chore: remove extra timeouts

8fe3908

chore: ci

3916137

chore: ci

fc31bdd

chore: slow ci is not that slow, also add debug for windows

f865164

chore: only debug during test run

b044ceb

achingbrain added 7 commits March 25, 2022 09:57

chore: just install

4c8e23d

chore: run all tests

aae00f1

chore: ci y u no ci

430041e

chore: update deps

b9f6a37

chore: ci

0c3a349

chore: ci

3b5ad46

chore: remove debug

bc0a19d

achingbrain changed the title ~~feat: convert to typescript~~ feat!: convert to typescript Mar 25, 2022

achingbrain added 2 commits March 25, 2022 16:20

chore: ci

30c0482

chore: ci

3fbfa2d

achingbrain requested a review from mpetrunic March 25, 2022 16:26

mpetrunic reviewed Mar 28, 2022

View reviewed changes

achingbrain merged commit 85ce5cf into libp2p:master Mar 28, 2022

github-actions bot added the released label Mar 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: convert to typescript #151

feat!: convert to typescript #151

vogdb commented Mar 9, 2022 •

edited

Loading

vogdb Mar 9, 2022

wemeetagain Mar 14, 2022

vogdb Mar 16, 2022

vogdb Mar 9, 2022

wemeetagain Mar 14, 2022

vogdb Mar 16, 2022

vogdb Mar 9, 2022 •

edited

Loading

wemeetagain Mar 14, 2022

vogdb Mar 16, 2022

vogdb commented Mar 14, 2022

achingbrain commented Mar 25, 2022 •

edited

Loading

achingbrain commented Mar 25, 2022

mpetrunic left a comment

github-actions bot commented Mar 28, 2022

feat!: convert to typescript #151

feat!: convert to typescript #151

Conversation

vogdb commented Mar 9, 2022 • edited Loading

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

vogdb Mar 9, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vogdb commented Mar 14, 2022

achingbrain commented Mar 25, 2022 • edited Loading

achingbrain commented Mar 25, 2022

mpetrunic left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 28, 2022

vogdb commented Mar 9, 2022 •

edited

Loading

vogdb Mar 9, 2022 •

edited

Loading

achingbrain commented Mar 25, 2022 •

edited

Loading