Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Properly separate ydoc-sync from custom comm messages

Aperta
#31 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
api, frontend

Direzione di ricerca

Inizia da src/notebookrenderer/yCommProvider.ts, in _onMsg, e segui come vengono distribuiti i messaggi con buffer binari. Esamina la gestione dei comm correlata in ypywidgets prima di definire un protocollo che distingua i messaggi di sincronizzazione ydoc dai messaggi personalizzati. Il lavoro è completato quando i messaggi comm personalizzati contenenti buffer binari non vengono più elaborati come messaggi di sincronizzazione ydoc e la breaking change è coordinata tra entrambi i progetti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

In yCommProvider, _onMsg treats any message with binary buffers as a ydoc sync message and everything else as a custom message. This is unfortunate, as we wouldn't be able to send custom comm messages that contain binary buffers — they'd be trapped here and processed as ydoc sync messages.

For now this is fine, since we're only partially supporting custom comms. But we should consider a breaking change in both ypywidgets and yjs-widgets to properly define a comm protocol with ydoc sync messages properly separated, e.g. branching on msg.type === 'ydoc-sync' instead of the buffers check.

Originally raised by @martinRenou in https://github.com/QuantStack/yjs-widgets/pull/30#discussion_r3587111607.

Lingua principale
TypeScript
Stelle
10
Fork
10
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di QuantStack/yjs-widgets

Tutte le issue di QuantStack/yjs-widgets

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.