feat!: add upgrader options #290

ckousik · 2022-09-27T10:30:21Z

Allow upgrader to accept a StreamMuxerFactory and skip encryption for transports that inherently support encryption and/or multiplexing (WebRTC, WebTransport, etc.)

ckousik · 2022-09-27T10:30:43Z

@mxinden @MarcoPolo

BigLep · 2022-10-04T15:35:56Z

Per #292 (comment)

Fixes: libp2p/js-libp2p#1382 and #287

Enables WebTransport: https://github.com/libp2p/js-libp2p-webtransport/

packages/interface-transport/package.json

MarcoPolo · 2022-10-05T15:54:44Z

packages/interface-stream-muxer/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@libp2p/interface-stream-muxer",
-  "version": "2.0.2",
+  "version": "2.0.3",


Should we avoid this too for the same reason as: #290 (comment) ?

ah, sorry. Will fix

ckousik · 2022-10-05T15:56:07Z

@MarcoPolo wouldn't we have to update the patch version since we have added features?

MarcoPolo · 2022-10-05T16:00:24Z

@achingbrain made it sound like the version numbers are handled by CI during release. I don't know much more.

mpetrunic · 2022-10-05T16:19:56Z

@MarcoPolo wouldn't we have to update the patch version since we have added features?

If you added a feature, a minor version should be updated. But in this case, since the title contains "feat:", CI will automatically update versions where needed.

achingbrain

LGTM, just needs the extra boolean option adding.

IMPORTANT: this is a breaking change. Before merging the following needs to happen:

The title of this PR needs to change from feat: add upgrader options to feat!: add upgrader options
The commit message needs to have the following added to it when this PR is squashed and merged (the format is important - "BREAKING CHANGE: " followed by a one-line sentence - this will be added to the release notes and changelog):

BREAKING CHANGE: the return type of StreamMuxer.newStream can now return a promise

Either one of the above two changes will make semantic-release rev the version numbers correctly when CI runs on master after merge. Both changes will make doubly sure it doesn't miss it.

achingbrain · 2022-10-05T18:29:33Z

packages/interface-stream-muxer/src/index.ts

@@ -18,7 +18,7 @@ export interface StreamMuxer extends Duplex<Uint8Array> {
   * Initiate a new stream with the given name. If no name is
   * provided, the id of the stream will be used.
   */
-  newStream: (name?: string) => Stream
+  newStream: (name?: string) => Stream | Promise<Stream>


Based on our learnings from #295 this is a breaking change.

Making this change locally with libp2p master indeed fails to compile.

packages/interface-transport/src/index.ts

achingbrain · 2022-10-06T09:37:28Z

I don't know why GH isn't showing the actions that have run on this PR but the build is failing. Can you please ensure you can run the build, lint and test npm scripts successfully.

ckousik · 2022-10-06T10:11:56Z

@achingbrain that is an older commit. I can run build, lint, and test successfully.

BREAKING CHANGE: the return type of StreamMuxer.newStream can now return a promise async new stream fix mocks Update packages/interface-transport/package.json Co-authored-by: Marco Munizaga <marco@marcopolo.io> test fix versioning fix lint

packages/interface-transport/src/index.ts

ckousik · 2022-10-06T13:06:51Z

@achingbrain Could you merge this? I don't have permissions to merge.

achingbrain · 2022-10-06T13:11:57Z

Yes, I was just waiting for CI to be green.

achingbrain · 2022-10-06T13:12:27Z

It's here, still not sure why it doesn't appear on this PR: https://github.com/libp2p/js-libp2p-interfaces/actions/runs/3197326618

## [@libp2p/interface-stream-muxer-v3.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-stream-muxer-v2.0.2...@libp2p/interface-stream-muxer-v3.0.0) (2022-10-06) ### ⚠ BREAKING CHANGES * the return type of StreamMuxer.newStream can now return a promise Co-authored-by: Marco Munizaga <marco@marcopolo.io> ### Features * add upgrader options ([#290](#290)) ([c502b66](c502b66))

github-actions · 2022-10-06T13:29:10Z

🎉 This PR is included in version @libp2p/interface-stream-muxer-v3.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [@libp2p/interface-stream-muxer-compliance-tests-v5.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-stream-muxer-compliance-tests-v4.0.0...@libp2p/interface-stream-muxer-compliance-tests-v5.0.0) (2022-10-06) ### ⚠ BREAKING CHANGES * the return type of StreamMuxer.newStream can now return a promise Co-authored-by: Marco Munizaga <marco@marcopolo.io> ### Features * add upgrader options ([#290](#290)) ([c502b66](c502b66)) ### Dependencies * update sibling dependencies ([66b4993](66b4993))

github-actions · 2022-10-06T13:30:13Z

🎉 This PR is included in version @libp2p/interface-stream-muxer-compliance-tests-v5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [@libp2p/interface-transport-v2.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-transport-v1.0.4...@libp2p/interface-transport-v2.0.0) (2022-10-06) ### ⚠ BREAKING CHANGES * the return type of StreamMuxer.newStream can now return a promise Co-authored-by: Marco Munizaga <marco@marcopolo.io> ### Features * add upgrader options ([#290](#290)) ([c502b66](c502b66)) ### Dependencies * update sibling dependencies ([66b4993](66b4993)) * update sibling dependencies ([5de9728](5de9728))

github-actions · 2022-10-06T13:30:44Z

🎉 This PR is included in version @libp2p/interface-transport-v2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [@libp2p/interface-mocks-v6.0.0](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-mocks-v5.1.0...@libp2p/interface-mocks-v6.0.0) (2022-10-06) ### ⚠ BREAKING CHANGES * the return type of StreamMuxer.newStream can now return a promise Co-authored-by: Marco Munizaga <marco@marcopolo.io> ### Features * add upgrader options ([#290](#290)) ([c502b66](c502b66)) ### Dependencies * update sibling dependencies ([0fae3ee](0fae3ee)) * update sibling dependencies ([8a89a05](8a89a05)) * update sibling dependencies ([66b4993](66b4993))

github-actions · 2022-10-06T13:31:17Z

🎉 This PR is included in version @libp2p/interface-mocks-v6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

mxinden mentioned this pull request Oct 3, 2022

webrtc/: Add libp2p WebRTC browser-to-server spec libp2p/specs#412

Merged

19 tasks

BigLep requested a review from achingbrain October 3, 2022 14:27

MarcoPolo approved these changes Oct 3, 2022

View reviewed changes

This was referenced Oct 3, 2022

feat: Interface changes to enable WebTransport #292

Closed

Tracking Issue: road to v0.1.0 libp2p/js-libp2p-webtransport#1

Closed

mpetrunic requested review from wemeetagain and mpetrunic October 4, 2022 15:38

achingbrain reviewed Oct 4, 2022

View reviewed changes

packages/interface-transport/package.json Outdated Show resolved Hide resolved

achingbrain changed the title ~~Add Upgrader Options~~ feat: add Upgrader Options Oct 4, 2022

achingbrain changed the title ~~feat: add Upgrader Options~~ feat: add upgrader options Oct 4, 2022

MarcoPolo reviewed Oct 4, 2022

View reviewed changes

packages/interface-transport/package.json Outdated Show resolved Hide resolved

ckousik mentioned this pull request Oct 5, 2022

feat: allow skipping encryption and custom muxer factory in upgrader libp2p/js-libp2p#1395

Closed

MarcoPolo approved these changes Oct 5, 2022

View reviewed changes

MarcoPolo reviewed Oct 5, 2022

View reviewed changes

MarcoPolo requested a review from achingbrain October 5, 2022 15:55

achingbrain suggested changes Oct 5, 2022

View reviewed changes

MarcoPolo changed the title ~~feat: add upgrader options~~ feat!: add upgrader options Oct 5, 2022

feat!: add upgrader options

1ea2e47

BREAKING CHANGE: the return type of StreamMuxer.newStream can now return a promise async new stream fix mocks Update packages/interface-transport/package.json Co-authored-by: Marco Munizaga <marco@marcopolo.io> test fix versioning fix lint

ckousik force-pushed the ckousik/upgrader-options branch from edfc77c to 1ea2e47 Compare October 6, 2022 10:15

achingbrain reviewed Oct 6, 2022

View reviewed changes

packages/interface-transport/src/index.ts Outdated Show resolved Hide resolved

fix upgrader interface

31e2997

achingbrain approved these changes Oct 6, 2022

View reviewed changes

achingbrain merged commit c502b66 into libp2p:master Oct 6, 2022

github-actions bot added the released label Oct 6, 2022

p-shahi mentioned this pull request Nov 10, 2022

WebRTC: Browser to Server libp2p/js-libp2p#1478

Closed

4 tasks

mpetrunic mentioned this pull request Nov 15, 2022

Stream Muxer should be allowed to return a promise #287

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: add upgrader options #290

feat!: add upgrader options #290

ckousik commented Sep 27, 2022

ckousik commented Sep 27, 2022

BigLep commented Oct 4, 2022

MarcoPolo Oct 5, 2022

ckousik Oct 5, 2022

ckousik commented Oct 5, 2022

MarcoPolo commented Oct 5, 2022

mpetrunic commented Oct 5, 2022

achingbrain left a comment •

edited

Loading

achingbrain Oct 5, 2022 •

edited

Loading

achingbrain commented Oct 6, 2022 •

edited

Loading

ckousik commented Oct 6, 2022

ckousik commented Oct 6, 2022

achingbrain commented Oct 6, 2022

achingbrain commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

feat!: add upgrader options #290

feat!: add upgrader options #290

Conversation

ckousik commented Sep 27, 2022

ckousik commented Sep 27, 2022

BigLep commented Oct 4, 2022

MarcoPolo Oct 5, 2022

Choose a reason for hiding this comment

ckousik Oct 5, 2022

Choose a reason for hiding this comment

ckousik commented Oct 5, 2022

MarcoPolo commented Oct 5, 2022

mpetrunic commented Oct 5, 2022

achingbrain left a comment • edited Loading

Choose a reason for hiding this comment

achingbrain Oct 5, 2022 • edited Loading

Choose a reason for hiding this comment

achingbrain commented Oct 6, 2022 • edited Loading

ckousik commented Oct 6, 2022

ckousik commented Oct 6, 2022

achingbrain commented Oct 6, 2022

achingbrain commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

github-actions bot commented Oct 6, 2022

achingbrain left a comment •

edited

Loading

achingbrain Oct 5, 2022 •

edited

Loading

achingbrain commented Oct 6, 2022 •

edited

Loading