restify/node-restify

Gzip plugin prevents text/event-stream from working

Open

#820 opened on Jun 2, 2015

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (10,695 stars) (983 forks)batch import
BugCriticalHelp WantedUnconfirmed

Description

I have to call

      res.handledGzip && res.handledGzip();
      res.removeHeader('Content-Encoding');

in my SSE plugin to bypass the Gzip plugin—otherwise EventSource fails.

The solution would involve adding support for keep alive connection in the Gzip plugin.

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js basicsUnderstanding of HTTP streamingRestify plugin system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the restify Gzip plugin implementation (likely in lib/plugins/gzip.js). The issue suggests that adding support for keep alive connections in the Gzip plugin would fix SSE. Look for current handling of 'Content Encoding' header and streaming responses. Consider how other frameworks handle gzip with SSE, and test with EventSource.