Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Properly separate ydoc-sync from custom comm messages

Abierto
#31 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
api, frontend

Línea de trabajo

Comienza en src/notebookrenderer/yCommProvider.ts, en _onMsg, y sigue cómo se despachan los mensajes con buffers binarios. Revisa el manejo relacionado de comm en ypywidgets antes de definir un protocolo que distinga los mensajes de sincronización de ydoc de los mensajes personalizados. Se considera terminado cuando los mensajes comm personalizados que contienen buffers binarios ya no se procesan como mensajes de sincronización de ydoc y el breaking change se coordina entre ambos proyectos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
10
Forks
10
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de QuantStack/yjs-widgets

Todos los issues de QuantStack/yjs-widgets

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.