Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Add one shared encoder for the server's event stream lines

已关闭
  • 哪里不对？
#241 2 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@kachamsiddarth 已经在做这个了。

开始于 2026年10月20日。

  • #284 来自 @kachamsiddarth —— 已合并

评估

这个 Issue 还没有评估数据。

描述

core enhancement good first issue hacktoberfest

Each server adapter builds its own SSE lines and writes its own data: [DONE] (packages/server/src/adapters/express.ts, lines 59 and 61, vercel.ts, lines 55 and 57, cloudflare.ts, lines 72 and 74), and their headers differ slightly. For protocol v1, one module will own the format so the adapters only move bytes. This issue is that module.

What to do
Create packages/core/src/protocol/sse.ts:

/** One event: `data: <json>` and a blank line. */
export function encodeSSE(part: WirePart | Record<string, unknown>): string;

/** A comment line that keeps the connection busy while nothing else is sent. */
export const SSE_PING: string;     // ': ping\n\n'

/** Ends the stream. */
export const SSE_DONE: string;     // 'data: [DONE]\n\n'

export const SSE_HEADERS: Readonly<Record<string, string>>;
  • SSE_HEADERS: Content-Type: text/event-stream; charset=utf-8, Cache-Control: no-cache, no-transform (stops proxies from compressing and buffering), X-Accel-Buffering: no (nginx). Leave out Connection. HTTP/2 doesn't allow it, and the runtimes handle it themselves.
  • encodeSSE must never produce a raw line break inside the data line. JSON.stringify already escapes \n and \r, so test that a part with line breaks in its text stays on one line. Also test that U+2028 and U+2029 survive.

Where to look

Acceptance criteria

  • New packages/core/src/protocol/sse.ts, exported from packages/core/src/protocol/index.ts and from @chatcops/core
  • Tests for the line format, line breaks in text, U+2028/U+2029, and the exact header values
  • The adapters aren't changed in this PR (I switch them over in the protocol PR)
  • Changeset for @chatcops/core (minor)
  • pnpm test:coverage and pnpm lint pass

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

主要语言
TypeScript
星标
13
派生
7
平均合并
3 小时 41 分钟
30 天内合并 PR
155

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

codercops/chatcops 的其他 Issue

查看 codercops/chatcops 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。