Initial support for real time collaboration #109

jtpio · 2021-05-28T13:47:54Z

References

#88

To try it out

https://jupyterlite--109.org.readthedocs.build/en/109/_static/lab/index.html?room=the-coolest-room

rtc-rtd.mp4

Code changes

Switch to WebrtcProvider
Set collaborative to true on the demo site
Basic link sharing to group users in rooms
~~Extra URL parameter to enable RTC? For example ?rtc=1 to enable, disabled otherwise~~ -> not needed
Update the docs to show how to use RTC features

User-facing changes

Add options to enable RTC to end users.

Backwards-incompatible changes

jtpio · 2021-05-28T16:28:54Z

packages/application-extension/src/index.ts

  constructor(options: IDocumentProviderFactory.IOptions) {
-    super(YJS_WEBSOCKET_URL, options.guid, options.ymodel.ydoc);
+    super(options.guid, options.ymodel.ydoc);
+    this.awareness = options.ymodel.awareness;


We could also make the signaling server(s) configurable via the settings / overrides.

Did this happen? I think we should add this configuration sprocket before merging.

jtpio · 2021-05-28T21:09:30Z

A simple "room" support a la Whereby. So folks can share links that look like the following:

https://jupyterlite.readthedocs.io/en/latest/_static/lab/?room=the-coolest-room

jtpio · 2021-05-28T22:32:41Z

RTC between lab and retro:

rtc-retro-lab.mp4

bollwyvl · 2021-07-03T01:16:47Z

As mentioned on #207: it looks like there is some new behavior on the yjs connector that needs to be accounted for.

implement setPath in packages/application-extension/src/index.tsx

didn't have time to go run this one down, yet

consider deferring to Initial support for real time collaboration #109?

Not sure which of these we'd be most likely to land first...

jtpio · 2021-07-08T22:19:48Z

Not sure which of these we'd be most likely to land first...

This PR still need a couple of fixes (sync when opening the documents), so probably we can get #207 in first and then rebase here.

jtpio · 2021-07-09T08:31:20Z

From https://readthedocs.org/projects/jupyterlite/builds/14201215/:

Command killed due to excessive memory consumption

Maybe a sign that we are starting to reach the limits? Will restart the build to double check.

jtpio · 2021-07-09T08:44:42Z

Also adding some docs about RTC: https://jupyterlite--109.org.readthedocs.build/en/109/rtc/index.html

jtpio · 2021-07-09T09:03:49Z

Pushed a couple of improvements to fix the issue with duplicated content when a document is opened.

Now hitting that one when creating a new notebook that is already opened and edited by a peer (they need to choose Overwrite):

But it looks like it's fine when opening a existing example notebook, so maybe something to check in the jupyterlite contents manager.

jtpio · 2021-07-09T09:04:41Z

so probably we can get #207 in first and then rebase here.

Since RTC is opt-in and also requires setting the room query string parameter, maybe we can actually merge this one first.

jtpio · 2021-07-09T09:19:44Z

@bollwyvl would you like to give it a try on the RTD demo?

https://jupyterlite--109.org.readthedocs.build/en/109/_static/lab/index.html?room=the-coolest-room

Thinking we could ship as is if it works ok, and we can address the contents manager issue in follow-up PRs.

jtpio · 2021-07-09T11:20:52Z

we can address the contents manager issue

For that we might want to start using y-indexeddb as an alternative (configurable) backend for the contents manager: https://github.com/yjs/y-indexeddb

bollwyvl · 2021-07-09T12:08:54Z

Command killed due to excessive memory consumption

Yeah, mamba let us sneak by over the initial hump, but webpack will increasingly destroy us.

Some band-aids until we really go after #118 (almost started trying to make some part of core federated, but worked on #238, because users can use it)

set the --max-old-space-size intentionally low, turn on all the caching, and hope that it can re-use cache results from failed runs to get there... eventually
split up some more parts of each app's build... perhaps the server and client could be separate builds... and heck, maybe server should be running in a webworker anyway...

using y-indexeddb as an alternative (configurable) backend for the contents

sounds like another issue... i don't understand fully the ramifications, but localForage is just nice, not criticial, as if a user's browser doesn't have indexeddb, they're likely going to have... other problems with this site.

bollwyvl · 2021-07-09T12:12:04Z

docs/rtc/index.md

+In addition to the `collaborative` flag, end users must specify the `room` query
+parameter in the URL. An example of such URL is as follows:
+
+[https://jupyterlite.readthedocs.io/en/latest/\_static/lab/index.html?room=my-custom-room](https://jupyterlite.readthedocs.io/en/latest/_static/lab/index.html?room=my-custom-room)


i wouldn't even make this a clickable link... and frankly, we shouldn't even suggest a room name, as we basically don't want people going to The One Room because it will get filled up with spam.

A nice approach might be to offer an RTC link generator with an in-page widget... though StringConcatenate isn't a thing, and wxyz doesn't work with requirejs

Good point. We can still show to specify the room parameter, but it could be something else or just a random string.

A nice approach might be to offer an RTC link generator with an in-page widget

Yes that would make it much more convenient to share a link.

An in-app one would be clutch, too, but could be a federated extension (let's not make webpack any worse until we make it better).

In this specific instance, I mean a link generator on the docs page, akin to the binder one, where we can hoist all of the bits and bobs.

bollwyvl · 2021-07-09T12:14:06Z

docs/rtc/index.md

+
+- the host, for example `jupyterlite.example.com` or `myserver:5000`
+- the name of the room parsed from the query string parameter, for example
+  `my-custom-room`


I wonder if the actual key that gets used in the code on the public server could at least be obfuscated, e.g. by taking the hash of the appName, appVersion and the user-provided key. My confidence is very low in any of these things working between different deployments... and see spam.

Yes there is still the risk of folks "seeing" each other. So having some kind of seed per deployment would greatly reduce the collisions.

bollwyvl · 2021-07-09T12:33:02Z

It indeed works (between browsers) on RTD, quite magical ✨

I feel like the presence indicator on the cursors b1 feels waaay better... and we'll want to make the list of "anonymous" names configurable, as people get real attached to those.

Overall (and i've raised this in core, too, somewhere) I feel like we need something that says, Hey buddy, you're broadcasting to everyone with this same room, and there's 800 people listening to your Untitled.ipynb, so don't put anything stupid in there.

Some ideas (not mutually exclusive):

overlays
- i despise the dialogs (here, lemme take away your agency), but feel like having an opt-out "THIS IS SHARED" dialog might be appropriate here may be appropriate
- we could use toast
main menu
- top-right, with a distinctive icon, and a peer count if we can get it
file manager
- change the file manager icon to be "shared folder" or "drive upload folder", make it orange
- somehow indicate that every damn file is shared, so can be overwritten at any moment
launcher
- add a note to top of launcher, e.g. "Shared with "
- add "Shared" to all of the launcher category titles
dock panel
- each shared tab should get something, but this is crazy lumino vdom
status bar
- add a positive (and negative) indicator that you are sharing (with a link to the docs section if not sharing)

So, technically I see no issues to merging, but there are a lot of social and perceptual issues that make this complicated.

bollwyvl · 2021-07-09T12:55:20Z

In punching it a few different ways, i was able to get to a state where one of the windows (the second launched) couldn't make a new file. After the first started a new file, then the second window could make a new file.

bollwyvl · 2021-07-09T12:56:53Z

editing bar.vl.json and seeing it update the plot on the other screen is very satisfying.

jtpio · 2021-07-09T14:18:18Z

sounds like another issue... i don't understand fully the ramifications, but localForage is just nice, not criticial, as if a user's browser doesn't have indexeddb, they're likely going to have... other problems with this site.

Definitely something else for later. localForage is really nice indeed, but if we start seeing more issues with decentralized content, if one day we enable rtc by default, then maybe indexeddb backed by Yjs could be interesting.

jtpio · 2021-07-09T14:21:22Z

Some ideas (not mutually exclusive):

Nice set of ideas 👍 We can definitely track them in separate issues, and many of these might actually be about reusing existing plugins or extensions made for "normal" RTC.

In punching it a few different ways, i was able to get to a state where one of the windows (the second launched) couldn't make a new file. After the first started a new file, then the second window could make a new file.

Right I've also seen these. Not sure how frequent they happen but probably something to do the with the requestInitialContent logic.

bollwyvl · 2021-07-09T14:23:06Z

enable rtc by default

let's not, like ever, until the sharing feature upstream isn't entirely opaque to the user. Like, a different IDrive. with lots of indicators of who can see it. And identity.

jtpio · 2021-07-09T14:24:18Z

let's not, like ever, until the sharing feature upstream isn't entirely opaque to the user. Like, a different IDrive. with lots of indicators of who can see it. And identity.

Yeah this will also be definitely relevant in lab and hub.

bollwyvl

LGTM, we can figure other stuff out in follow-ons.

jtpio changed the title ~~Use WebrtcProvider for RTC~~ Initial support for real time collaboration May 28, 2021

jtpio commented May 28, 2021

View reviewed changes

jtpio force-pushed the rtc branch 3 times, most recently from 6918651 to 77902dc Compare June 3, 2021 13:45

jtpio added the enhancement New feature or request label Jun 22, 2021

jtpio force-pushed the rtc branch from 77902dc to ec70f76 Compare June 22, 2021 18:20

jtpio mentioned this pull request Jun 22, 2021

Add changelog for v0.1.0a0 #169

Merged

jtpio force-pushed the rtc branch from ec70f76 to 72dc6cc Compare June 23, 2021 21:22

This was referenced Jul 1, 2021

Support (Jupyter) Debug Adapter Protocol robots-from-jupyter/robotkernel#71

Open

Upgrade to JupyterLab 3.1.0rc1 #207

Merged

jtpio added 6 commits July 9, 2021 00:12

Use WebrtcProvider for RTC

1d43b7a

Enable RTC on the demo site

7726b90

Override awareness only

1ef6416

Resolve false

1a18ac8

Basic room handling for RTC

70d701f

Better handle multiple query string in retro

54497b6

jtpio force-pushed the rtc branch from 72dc6cc to 54497b6 Compare July 8, 2021 22:18

jtpio added 6 commits July 9, 2021 01:13

Improve the document loading experience

c55a7c5

Enable RTC if page config set room url param defined

043c253

Scope room per host

afb3952

Basic structure for RTC docs

2133723

More RTC docs

03a985c

Add rtc on rtd screencast

074f7c6

Trim room name parameter

5acd26a

bollwyvl reviewed Jul 9, 2021

View reviewed changes

Update example RTC link in the docs

1c97bb8

jtpio marked this pull request as ready for review July 9, 2021 14:24

bollwyvl approved these changes Jul 9, 2021

View reviewed changes

bollwyvl mentioned this pull request Jul 9, 2021

Improve usability/transparency of shared editing #241

Open

jtpio merged commit 90d6c04 into main Jul 12, 2021

jtpio deleted the rtc branch July 12, 2021 07:39

This was referenced Jul 13, 2021

Real Time Collaboration #88

Closed

RTC: File Changed dialog jupyterlite/jupyterlab-webrtc-docprovider#19

Open

jtpio added this to the 0.1.0 milestone Oct 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial support for real time collaboration #109

Initial support for real time collaboration #109

jtpio commented May 28, 2021 •

edited

Loading

jtpio May 28, 2021

bollwyvl Jul 9, 2021

jtpio commented May 28, 2021

jtpio commented May 28, 2021

bollwyvl commented Jul 3, 2021

jtpio commented Jul 8, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

bollwyvl Jul 9, 2021 •

edited

Loading

jtpio Jul 9, 2021

bollwyvl Jul 9, 2021

bollwyvl Jul 9, 2021

jtpio Jul 9, 2021 •

edited

Loading

bollwyvl commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl left a comment

Initial support for real time collaboration #109

Initial support for real time collaboration #109

Conversation

jtpio commented May 28, 2021 • edited Loading

References

Code changes

User-facing changes

Backwards-incompatible changes

jtpio May 28, 2021

Choose a reason for hiding this comment

bollwyvl Jul 9, 2021

Choose a reason for hiding this comment

jtpio commented May 28, 2021

jtpio commented May 28, 2021

bollwyvl commented Jul 3, 2021

jtpio commented Jul 8, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

bollwyvl Jul 9, 2021 • edited Loading

Choose a reason for hiding this comment

jtpio Jul 9, 2021

Choose a reason for hiding this comment

bollwyvl Jul 9, 2021

Choose a reason for hiding this comment

bollwyvl Jul 9, 2021

Choose a reason for hiding this comment

jtpio Jul 9, 2021 • edited Loading

Choose a reason for hiding this comment

bollwyvl commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

jtpio commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl commented Jul 9, 2021

jtpio commented Jul 9, 2021

bollwyvl left a comment

Choose a reason for hiding this comment

jtpio commented May 28, 2021 •

edited

Loading

bollwyvl Jul 9, 2021 •

edited

Loading

jtpio Jul 9, 2021 •

edited

Loading