ipfs/kubo

--read-timeout option for `ipfs get`

Open

#5541 opened on Sep 28, 2018

View on GitHub
 (15 comments) (6 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
exp/novicehelp wantedkind/enhancement

Description

It would be useful for ipfs get (and possibly other related commands like ipfs cat) to have a --read-timeout option which would interrupt the command if no new data was read for a set amount of time.

Mentioned in https://github.com/ipfs/go-ipfs/issues/5537#issuecomment-425478248

Contributor guide

Tech stack
go
Domain
cli
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.
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
GoIPFS basicscommand line flag parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate existing timeout implementations in kubo, such as those used for HTTP requests. Review the command definition for 'ipfs get' in the commands package to understand how flags are registered. Consider implementing a per read timeout that interrupts the command after a specified period of no data. Ensure that the option is clearly documented and tested.