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

[Protocol] v2 提案:数据面二进制帧(替换 base64-in-JSON),JSON 控制面不变

Abierto
#3 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 7 días

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
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python, rust, typescript

Línea de trabajo

No repository files, tests, or entry points are named. Start by locating the existing auth/auth_ok negotiation and JSON tcp_data paths across the server and the TypeScript, Rust, and Python clients. Done means negotiated binary framing with JSON fallback, all three clients working, benchmark results recorded, and the full test suite passing.

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

Descripción

背景与目标

当前 TCP/流数据走 JSON 文本帧内嵌 base64:体积 +33%、每 chunk 一次 JSON 编解码、无二进制通道。目标:只把数据面换成 WS 二进制帧,控制面(认证/心跳/连接建立/关闭/HTTP 转发)保持 JSON 不动,通过认证消息协商,新旧客户端共存。

设计草图

  1. 协商:auth 增加 "features": ["binary-data"](客户端 → 服务端);auth_ok 回 "features": [...](服务端 → 客户端)。双方都支持才启用;任一方不支持自动落回 JSON 路径,零破坏升级。
  2. 二进制帧布局(WebSocket Binary 消息):
    [1B 版本=0x02][1B 类型=0x01 data|0x02 close][16B conn_id(UUID 原始字节)][payload]
    • tcp_data 的 payload 即原始字节(省 base64 与 JSON)
    • tcp_close 二进制化可选:close 低频,保留 JSON 亦可(携带 error 字段)
  3. conn_id:服务端生成 UUID v4,16 字节原始形式随帧传递;JSON 控制消息中仍是字符串形式。
  4. 读写粒度:服务端与客户端统一提到 64KB;背压策略本期不做(与现状一致)。
  5. 预期收益:传输体积 -25%(对照 base64),CPU 省两次 JSON+base64 编解码,吞吐对齐 frp 量级还有差距(无多路复用头压缩),但先行解决大头。

验收

  • 协商开关:旧客户端(无 features)与新服务端共存,行为与 0.5.x 一致
  • TS / Rust / Python 三客户端实现二进制路径(Rust 优先)
  • 吞吐基准:本地回环大文件对传,对比 v1 记录提升数据
  • 全量测试三端绿 + 真实部署灰度

参考

tunely 0.5.0 已含多监听器(WS_TUNNEL_TCP_LISTEN)与流量统计;本提案是数据面的下一步。

Lenguaje dominante
Python
Estrellas
0
Forks
0
Merge medio
6 d 2 h
PR fusionados (30 d)
2

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 jeffkit/tunely

Todos los issues de jeffkit/tunely

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.