haskell-servant/servant

Add a test for streaming of response bodies using lazy Bytestrings in servant-server

Open

#612 opened on Oct 9, 2016

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Haskell (422 forks)batch import
help wantedservant-server

Repository metrics

Stars
 (1,953 stars)
PR merge metrics
 (Avg merge 5h 49m) (2 merged PRs in 30d)

Description

Currently unfortunately this is not supported. MimeRender is the class that is used to create response bodies. mimeRender returns lazy ByteStrings so servant-server could stream the response lazily, but I have no idea whether it does that or not. And even if it did we have no test making sure that this property will not break at some point.

Btw, there's a test that makes sure streaming of request bodies works in servant-server: StreamingSpec.hs. I think a test for streaming responses would look similar.

Contributor guide

Research direction
Investigate the existing StreamingSpec.hs test for request body streaming and create a similar test for response body streaming using lazy ByteStrings. Inspect how mimeRender is used and ensure servant server streams the response lazily.
Tech stack
haskell
Domain
backend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Haskellservant
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65