https://github.com/datalayer/jupyter-rtc-test

💪 Stress tests for 🪐 Jupyter 🧑‍🤝‍🧑 Real Time Collaboration (RTC).
https://github.com/datalayer/jupyter-rtc-test

jupyter python rtc stresstest test yjs

Last synced: about 2 months ago
JSON representation

💪 Stress tests for 🪐 Jupyter 🧑‍🤝‍🧑 Real Time Collaboration (RTC).

• Host: GitHub
• URL: https://github.com/datalayer/jupyter-rtc-test
• Owner: datalayer
• License: bsd-3-clause
• Created: 2023-03-28T15:41:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T21:39:06.000Z (4 months ago)
• Last Synced: 2024-11-01T06:42:34.411Z (2 months ago)
• Topics: jupyter, python, rtc, stresstest, test, yjs
• Language: Python
• Homepage: https://datalayer.tech
• Size: 2.65 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)

[![Become a Sponsor](https://img.shields.io/static/v1?label=Become%20a%20Sponsor&message=%E2%9D%A4&logo=GitHub&style=flat&color=1ABC9C)](https://github.com/sponsors/datalayer)

# 🪐 🧑‍🤝‍🧑 💪 Jupyter RTC Test

> Stress tests for Jupyter Real Time Collaboration (RTC).

The goal of this repository is to stress test the Real Time Collaboration (RTC) feature of JupyterLab and Jupyter Server and is a needed requirement to avoid [users having issues when they enable RTC](./docs/why.md).

You can run the stress tests from the CLI (Command Line Interface) or from a UI (User Interface).



  



## Distributed Actors

The tests aims to replicate real life cases, meaning that most of them are running in a distributed way.

You can run the tests on a standalone (local laptop or CI) machine, in which case the distributed behavior is simulated. You can also run the tests in a real a distributed environment like Kubernetes, this however requires you to setup additional infrastructure and configuration. Please note you can also run the Kubernetes flavored tests on a local Minikube instance.



  



## Discovered issues and Explored solutions

We maintain [a list of discovered issues](./docs/issues.md) as well a [explored solutions](./docs/solutions.md).

## Technical Stack

The Jupyter RTC technical stack is spread across various repositories listed here (if you want to learn more, read the [architecture document](./docs/architecture.md))

- Yjs https://github.com/yjs/yjs

- Yrs https://github.com/y-crdt/y-crdt/tree/main/yrs

- Ywasm https://github.com/y-crdt/y-crdt/tree/main/ywasm

- Ypy https://github.com/y-crdt/ypy

- Ystore see https://github.com/y-crdt/ypy-websocket/issues/19

- Ypy Websocket https://github.com/y-crdt/ypy-websocket

- Jupyter YDoc https://github.com/jupyter-server/jupyter_ydoc

- Jupyter Collaboration https://github.com/jupyterlab/jupyter_collaboration



  



## Community

The RTC stress test are being discussed [in an issue on the official JupyterLab repository](https://github.com/jupyterlab/jupyterlab/issues/14532).

## Develop

Setup your [environment](./docs/environment.md) to run the [tests](./docs/tests.md).

You can also use the [user interface](./docs/ui.md) if you prefer.

## About CRDT

You can read more about the Conflict free Replicated Data Types (CRDT).

- [CRDT.tech](https://crdt.tech)

- [JupyterCon 2020 - Jupyter Realtime Collaboration](https://www.youtube.com/watch?v=mUGUxWZjR7E)

- [Wikipedia](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type)

- [Y.js](https://docs.yjs.dev) used as CRDT implementation.

## ⚖️ License

Copyright (c) 2023 Datalayer, Inc.

Released under the terms of the BSD 3-Clause license (see [LICENSE](./LICENSE)).

This repository contains source code taken from the various repositories under `BSD-3` or `MIT` license.