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

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

Aperta
  • Qualcosa non va?
#241 2 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@kachamsiddarth ci sta già lavorando.

Dal 20/10/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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.

Lingua principale
TypeScript
Stelle
13
Fork
7
Merge medio
4h 11m
PR unite (30g)
122

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 codercops/chatcops

Tutte le issue di codercops/chatcops

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.