Implement WebRTC Data Channel. #1238

ctrlaltdavid · 2021-05-31T22:33:48Z

Implements the WebRTC data channel.

This PR is targeted at the webapp feature branch, where Web app-related changes will be accumulated and tested before being periodically merged into master (and vice-versa).

It builds upon PR #1221 which needs to be merged first. The changes in this PR start in commit 6c37628.

QA: ~~See the Vircadia-Web-SDK PR: vircadia/vircadia-web-sdk#6~~ See the Vircadia-Web-SDK PR: vircadia/vircadia-web-sdk#10

Merge sequence:

Vircadia PR: Add WebRTC Signaling Channel. #1219
Vircadia PR: Conditionally include WebRTCSignalingServer.h #1239
Vircadia PR: Update WebRTC package for Windows. #1258
Vircadia-Web-SDK PR: Setup WebRTC Data Channel support. vircadia-web-sdk#6
Vircadia PR: Update webapp feature branch with current master #1261
Update Vircadia-Web repo to use the latest Vircadia-Web-SDK.
Vircadia-Web PR: Update submodule vircadia-web-sdk to latest master to support WebRTC data channel feature. vircadia-web#13
Update this PR to use the latest Vircadia-Web master branch.
CR, QA.
Merge this PR.

vircadia-build-notifier · 2021-06-01T00:24:31Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-e42c269-_c28f4749.dmg

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-e42c269-_c28f4749.exe

vircadia-build-notifier · 2021-06-01T05:32:35Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-1623b25-_645dc265.dmg

build (ubuntu-18.04, full)

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-1623b25-_645dc265.dmg

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-1623b25-_645dc265.exe

…annel # Conflicts: # domain-server/src/DomainServer.h

vircadia-build-notifier · 2021-06-05T04:51:29Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-a8ba2c5-_2402a5e3.dmg

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-a8ba2c5-_2402a5e3.dmg

build (ubuntu-18.04, full)

build (ubuntu-18.04, android)

vircadia-build-notifier · 2021-06-05T07:59:01Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-9a68e96-_28c408de.dmg

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-9a68e96-_28c408de.dmg

build (ubuntu-18.04, full)

build (ubuntu-18.04, android)

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-9a68e96-_28c408de.exe

vircadia-build-notifier · 2021-06-26T23:33:15Z

The following links are available:
build (ubuntu-18.04, full)

build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-d5155f7-_303ff9a7.dmg

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-d5155f7-_303ff9a7.dmg

build (ubuntu-18.04, android)

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-d5155f7-_303ff9a7.exe

vircadia-build-notifier · 2021-06-28T01:16:39Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-c49ac16-_6b188d88.dmg

build (ubuntu-18.04, full)

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-c49ac16-_6b188d88.dmg

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-c49ac16-_6b188d88.exe

build (ubuntu-18.04, android)

vircadia-build-notifier · 2021-06-28T01:48:55Z

The following links are available:
build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-6201675-_a0a0e8db.dmg

build (ubuntu-18.04, full)

libraries/networking/CMakeLists.txt

libraries/networking/src/webrtc/WebRTCDataChannels.cpp

daleglass · 2021-07-01T19:47:20Z

libraries/networking/src/webrtc/WebRTCDataChannels.cpp

+#ifdef WEBRTC_DEBUG
+    qCDebug(networking_webrtc) << "WDCConnection::sendDataMessage()";
+#endif
+    const int MAX_WEBRTC_BUFFER_SIZE = 16 * 1024 * 1024;  // 16MB


Constant probably should be somewhere else, perhaps at the top of the file?
Why 16M? Is this a protocol issue, or just a sane memory limit?

What kind of data will be sent? Textures may exceed 16M quite easily.

There should be some sort of log message here, too.

This is a WebRTC protocol limit in the WebRTC Send() method. This is just how much data can be buffered to send. Ultimately, it's called via Socket::writeDatagram() - in PR1259 - and UDP sockets can similarly fail to write date. The Vircadia protocol handles this situation (dropping unreliable packets and resending reliable packets). And large data items are chopped up into multi-packet messages with the packets sent individually by this method (or similar UDP method).

daleglass · 2021-07-01T19:59:24Z

libraries/shared/src/shared/WebRTC.h


 #if defined(Q_OS_MAC)
 #  define WEBRTC_AUDIO 1
 #  define WEBRTC_POSIX 1
 #  define WEBRTC_LEGACY 1
 #elif defined(Q_OS_WIN)
 #  define WEBRTC_AUDIO 1
-#  define WEBRTC_DATA_CHANNEL 1
+#  define WEBRTC_DATA_CHANNELS 1


Perhaps the constants should be named something like ENABLE_WEBRTC_DATA_CHANNELS instead, for clarity?

I think the "topic" of the define ("WEBRTC") coming first makes it easier to distinguish these defines from other defines and group related ones together.

vircadia-build-notifier · 2021-07-04T06:38:56Z

The following links are available:
build (ubuntu-18.04, full)

build (macOS-latest, client)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-Interface-PR1238-c0e20b4-_7ecd9b6b.dmg

build (macOS-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-c0e20b4-_7ecd9b6b.dmg

build (ubuntu-18.04, android)

build (windows-latest, full)

https://athena-public.s3.eu-west-3.amazonaws.com/builds/PR/vircadia_vircadia/PR1238/Vircadia-PR1238-c0e20b4-_7ecd9b6b.exe

ctrlaltdavid · 2021-07-05T19:31:19Z

Latest changes should be QA'd using Web SDK PR vircadia/vircadia-web-sdk#10

digisomni · 2021-07-06T21:43:24Z

Le Wild Kalila has tested this again with vircadia/vircadia-web-sdk PR #10 by running a basic test suite.

ctrlaltdavid added 4 commits May 31, 2021 12:29

Add WebRTC data channel

6c37628

Fix data channel ID

e6c49cf

Code tidying

63ec933

Doxygen tidying

c28f474

ctrlaltdavid added do not merge do not merge due to issues or pending updates needs testing (QA) The PR is ready for testing needs CR (code review) labels May 31, 2021

ctrlaltdavid mentioned this pull request May 31, 2021

Setup WebRTC Data Channel support. vircadia/vircadia-web-sdk#6

Merged

Fix non-WebRTC domain server builds

645dc26

ctrlaltdavid mentioned this pull request Jun 2, 2021

Add minimal documentation for classes declared in script-engine. #1223

Merged

ctrlaltdavid added 2 commits June 5, 2021 14:21

Merge branch 'master' into dev/webrtc-datachannel

4681475

Merge remote-tracking branch 'upstream/webapp' into dev/webrtc-datach…

2402a5e

…annel # Conflicts: # domain-server/src/DomainServer.h

Typo

28c408d

Merge branch 'webapp' into dev/webrtc-datachannel

303ff9a

ctrlaltdavid added 2 commits June 28, 2021 09:42

Merge branch 'webapp' into dev/webrtc-datachannel

a0a0e8d

Update to latest Vircadia-Web

6b188d8

ctrlaltdavid removed the do not merge do not merge due to issues or pending updates label Jun 27, 2021

digisomni added QA Approved The PR has been tested successfully. and removed needs testing (QA) The PR is ready for testing labels Jun 27, 2021

ctrlaltdavid mentioned this pull request Jul 1, 2021

First exchange of Vircadia protocol packets with the Domain server. vircadia/vircadia-web-sdk#9

Merged

3 tasks

daleglass suggested changes Jul 1, 2021

View reviewed changes

ctrlaltdavid added 2 commits July 3, 2021 08:43

Typo

dacda84

Fix WebRTC peer connection not being closed properly

f6a8ae2

ctrlaltdavid added 2 commits July 4, 2021 15:57

Add missing Doxygen

e682336

Miscellaneous tidying

7ecd9b6

ctrlaltdavid mentioned this pull request Jul 4, 2021

Make connection closes more robust. vircadia/vircadia-web-sdk#10

Merged

ctrlaltdavid added needs testing (QA) The PR is ready for testing and removed QA Approved The PR has been tested successfully. labels Jul 4, 2021

ctrlaltdavid requested a review from daleglass July 4, 2021 04:46

digisomni added this to Review in progress in Web Part 1: Interface + SDK - May through October 2021 Jul 5, 2021

digisomni moved this from Review in progress to In progress in Web Part 1: Interface + SDK - May through October 2021 Jul 5, 2021

ctrlaltdavid moved this from In progress to Review in progress in Web Part 1: Interface + SDK - May through October 2021 Jul 5, 2021

ctrlaltdavid added enhancement New feature or request web sdk Related to the Vircadia Web SDK labels Jul 6, 2021

ctrlaltdavid mentioned this pull request Jul 6, 2021

First exchange of Vircadia protocol packets with the Vircadia Web SDK. #1259

Merged

7 tasks

digisomni added QA Approved The PR has been tested successfully. and removed needs testing (QA) The PR is ready for testing labels Jul 6, 2021

daleglass approved these changes Jul 7, 2021

View reviewed changes

Web Part 1: Interface + SDK - May through October 2021 automation moved this from Review in progress to Reviewer approved Jul 7, 2021

digisomni added CR Approved At least one code reviewer has approved the PR. and removed needs CR (code review) labels Jul 7, 2021

digisomni merged commit 5a2ca48 into vircadia:webapp Jul 7, 2021

Web Part 1: Interface + SDK - May through October 2021 automation moved this from Reviewer approved to Done Jul 7, 2021

ctrlaltdavid deleted the dev/webrtc-datachannel branch July 8, 2021 03:53

digisomni changed the title ~~WebRTC Data Channel~~ Implement WebRTC Data Channel. Sep 7, 2021

digisomni added unmerged-dev A project being developed in parallel to master, to be merged at a later date. and removed enhancement New feature or request labels Sep 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement WebRTC Data Channel. #1238

Implement WebRTC Data Channel. #1238

ctrlaltdavid commented May 31, 2021 •

edited

Loading

vircadia-build-notifier commented Jun 1, 2021

vircadia-build-notifier commented Jun 1, 2021

vircadia-build-notifier commented Jun 5, 2021

vircadia-build-notifier commented Jun 5, 2021

vircadia-build-notifier commented Jun 26, 2021

vircadia-build-notifier commented Jun 28, 2021

vircadia-build-notifier commented Jun 28, 2021

daleglass Jul 1, 2021

ctrlaltdavid Jul 4, 2021 •

edited

Loading

daleglass Jul 1, 2021

ctrlaltdavid Jul 4, 2021

vircadia-build-notifier commented Jul 4, 2021

ctrlaltdavid commented Jul 5, 2021 •

edited

Loading

digisomni commented Jul 6, 2021

Implement WebRTC Data Channel. #1238

Implement WebRTC Data Channel. #1238

Conversation

ctrlaltdavid commented May 31, 2021 • edited Loading

vircadia-build-notifier commented Jun 1, 2021

vircadia-build-notifier commented Jun 1, 2021

vircadia-build-notifier commented Jun 5, 2021

vircadia-build-notifier commented Jun 5, 2021

vircadia-build-notifier commented Jun 26, 2021

vircadia-build-notifier commented Jun 28, 2021

vircadia-build-notifier commented Jun 28, 2021

daleglass Jul 1, 2021

Choose a reason for hiding this comment

ctrlaltdavid Jul 4, 2021 • edited Loading

Choose a reason for hiding this comment

daleglass Jul 1, 2021

Choose a reason for hiding this comment

ctrlaltdavid Jul 4, 2021

Choose a reason for hiding this comment

vircadia-build-notifier commented Jul 4, 2021

ctrlaltdavid commented Jul 5, 2021 • edited Loading

digisomni commented Jul 6, 2021

ctrlaltdavid commented May 31, 2021 •

edited

Loading

ctrlaltdavid Jul 4, 2021 •

edited

Loading

ctrlaltdavid commented Jul 5, 2021 •

edited

Loading