ipfs/kubo

Compressed response from server

Open

#4385 opened on Nov 13, 2017

View on GitHub
 (3 comments) (3 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/enhancement

Description

Version information:

go-ipfs version: 0.4.11- Repo version: 6 System version: amd64/windows Golang version: go1.9

Type: Enhancement

Description:

Compressing the response from the server can lower bandwidth requirements, especially when transferring large blocks.

The HTTP header Accept-Encoding: gzip should be accepted in a request. The server should then send a compressed response with Content-Encoding: gzip

Contributor guide

Tech stack
go
Domain
backendapi
Issue type
feature
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.
half day
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
Go programmingHTTP protocolgzip compression
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Look at the HTTP gateway handler in the go ipfs codebase, specifically in the 'core/http' or 'cmd/ipfs' directories. The issue requests adding support for Accept Encoding: gzip and responding with Content Encoding: gzip. A common approach is to use a middleware that wraps the response writer with gzip compression. Check if there are existing middlewares or a way to plug in compression. The implementation should be server wide or configurable. Review any linked PRs or comments for additional context.