GetArchive should return an io.ReadCloser #475

New Issue

petergardfjall · 2021-01-15T10:44:56Z

petergardfjall commented

2021-01-15 10:44:56 +00:00

The GetArchive call appears to be designed with very small repositories in mind, since it returns the entire archive zip/tar.gz in the client's memory. For larger repositories this appears both infeasible (risking to blow up the client memory-wise) and very non-idiomatic (for Go code).

The natural choice (IMHO) would have been to return an io.ReadCloser since I figure that the common thing is for the client to stream the archive to a file on disk (or similar) before processing it. Anyway, an io.ReadCloser that reads the response body content would be endlessly more flexible.

So instead of:

func (c *Client) GetArchive(owner, repo, ref string, ext ArchiveType) ([]byte, *Response, error)

it would be nice to have something like:

func (c *Client) GetArchive(owner, repo, ref string, ext ArchiveType) (io.ReadCloser, error)

If backwards-compatibility is a concern maybe introduce a new method:

func (c *Client) GetArchiveReader(owner, repo, ref string, ext ArchiveType) (io.ReadCloser, error)

The `GetArchive` call appears to be designed with very small repositories in mind, since it returns the entire archive zip/tar.gz in the client's memory. For larger repositories this appears both infeasible (risking to blow up the client memory-wise) and very non-idiomatic (for Go code). The natural choice (IMHO) would have been to return an `io.ReadCloser` since I figure that the common thing is for the client to stream the archive to a file on disk (or similar) before processing it. Anyway, an `io.ReadCloser` that reads the response body content would be endlessly more flexible. So instead of: ``` func (c *Client) GetArchive(owner, repo, ref string, ext ArchiveType) ([]byte, *Response, error) ``` it would be nice to have something like: ``` func (c *Client) GetArchive(owner, repo, ref string, ext ArchiveType) (io.ReadCloser, error) ``` If backwards-compatibility is a concern maybe introduce a new method: ``` func (c *Client) GetArchiveReader(owner, repo, ref string, ext ArchiveType) (io.ReadCloser, error) ```

~~petergardfjall referenced this issue 2021-01-15 13:46:54 +00:00~~

introduce Client.GetArchiveReader #476

6543 added the

has/pull

kind/proposal

labels 2021-01-15 14:42:15 +00:00

6543 referenced a pull request that will close this issue

2021-01-17 17:13:50 +00:00

introduce Client.GetArchiveReader #476

6543 referenced this issue from a commit

2021-01-17 17:14:08 +00:00

Add GetArchiveReader() (#476)