9b9d76f92d
This commit introduces the new go-libp2p-gorpc streaming capabilities for Cluster. The main aim is to work towards heavily reducing memory usage when working with very large pinsets. As a side-effect, it takes the chance to revampt all types for all public methods so that pointers to static what should be static objects are not used anymore. This should heavily reduce heap allocations and GC activity. The main change is that state.List now returns a channel from which to read the pins, rather than pins being all loaded into a huge slice. Things reading pins have been all updated to iterate on the channel rather than on the slice. The full pinset is no longer fully loaded onto memory for things that run regularly like StateSync(). Additionally, the /allocations endpoint of the rest API no longer returns an array of pins, but rather streams json-encoded pin objects directly. This change has extended to the restapi client (which puts pins into a channel as they arrive) and to ipfs-cluster-ctl. There are still pending improvements like StatusAll() calls which should also stream responses, and specially BlockPut calls which should stream blocks directly into IPFS on a single call. These are coming up in future commits.
163 lines
3.3 KiB
Go
163 lines
3.3 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/ipfs/ipfs-cluster/api"
|
|
|
|
"go.opencensus.io/trace"
|
|
)
|
|
|
|
type responseDecoder func(d *json.Decoder) error
|
|
|
|
func (c *defaultClient) do(
|
|
ctx context.Context,
|
|
method, path string,
|
|
headers map[string]string,
|
|
body io.Reader,
|
|
obj interface{},
|
|
) error {
|
|
|
|
resp, err := c.doRequest(ctx, method, path, headers, body)
|
|
if err != nil {
|
|
return api.Error{Code: 0, Message: err.Error()}
|
|
}
|
|
return c.handleResponse(resp, obj)
|
|
}
|
|
|
|
func (c *defaultClient) doStream(
|
|
ctx context.Context,
|
|
method, path string,
|
|
headers map[string]string,
|
|
body io.Reader,
|
|
outHandler responseDecoder,
|
|
) error {
|
|
|
|
resp, err := c.doRequest(ctx, method, path, headers, body)
|
|
if err != nil {
|
|
return api.Error{Code: 0, Message: err.Error()}
|
|
}
|
|
return c.handleStreamResponse(resp, outHandler)
|
|
}
|
|
|
|
func (c *defaultClient) doRequest(
|
|
ctx context.Context,
|
|
method, path string,
|
|
headers map[string]string,
|
|
body io.Reader,
|
|
) (*http.Response, error) {
|
|
span := trace.FromContext(ctx)
|
|
span.AddAttributes(
|
|
trace.StringAttribute("method", method),
|
|
trace.StringAttribute("path", path),
|
|
)
|
|
defer span.End()
|
|
|
|
urlpath := c.net + "://" + c.hostname + "/" + strings.TrimPrefix(path, "/")
|
|
logger.Debugf("%s: %s", method, urlpath)
|
|
|
|
r, err := http.NewRequestWithContext(ctx, method, urlpath, body)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if c.config.DisableKeepAlives {
|
|
r.Close = true
|
|
}
|
|
|
|
if c.config.Username != "" {
|
|
r.SetBasicAuth(c.config.Username, c.config.Password)
|
|
}
|
|
|
|
for k, v := range headers {
|
|
r.Header.Set(k, v)
|
|
}
|
|
|
|
if body != nil {
|
|
r.ContentLength = -1 // this lets go use "chunked".
|
|
}
|
|
|
|
ctx = trace.NewContext(ctx, span)
|
|
r = r.WithContext(ctx)
|
|
|
|
return c.client.Do(r)
|
|
}
|
|
func (c *defaultClient) handleResponse(resp *http.Response, obj interface{}) error {
|
|
body, err := ioutil.ReadAll(resp.Body)
|
|
resp.Body.Close()
|
|
|
|
if err != nil {
|
|
return api.Error{Code: resp.StatusCode, Message: err.Error()}
|
|
}
|
|
logger.Debugf("Response body: %s", body)
|
|
|
|
switch {
|
|
case resp.StatusCode == http.StatusAccepted:
|
|
logger.Debug("Request accepted")
|
|
case resp.StatusCode == http.StatusNoContent:
|
|
logger.Debug("Request succeeded. Response has no content")
|
|
default:
|
|
if resp.StatusCode > 399 && resp.StatusCode < 600 {
|
|
var apiErr api.Error
|
|
err = json.Unmarshal(body, &apiErr)
|
|
if err != nil {
|
|
// not json. 404s etc.
|
|
return api.Error{
|
|
Code: resp.StatusCode,
|
|
Message: string(body),
|
|
}
|
|
}
|
|
return apiErr
|
|
}
|
|
err = json.Unmarshal(body, obj)
|
|
if err != nil {
|
|
return api.Error{
|
|
Code: resp.StatusCode,
|
|
Message: err.Error(),
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (c *defaultClient) handleStreamResponse(resp *http.Response, handler responseDecoder) error {
|
|
if resp.StatusCode > 399 && resp.StatusCode < 600 {
|
|
return c.handleResponse(resp, nil)
|
|
}
|
|
|
|
defer resp.Body.Close()
|
|
|
|
if resp.StatusCode != http.StatusOK {
|
|
return api.Error{
|
|
Code: resp.StatusCode,
|
|
Message: "expected streaming response with code 200",
|
|
}
|
|
}
|
|
|
|
dec := json.NewDecoder(resp.Body)
|
|
for {
|
|
err := handler(dec)
|
|
if err == io.EOF {
|
|
// we need to check trailers
|
|
break
|
|
}
|
|
if err != nil {
|
|
logger.Error(err)
|
|
return err
|
|
}
|
|
}
|
|
|
|
errTrailer := resp.Trailer.Get("X-Stream-Error")
|
|
if errTrailer != "" {
|
|
return api.Error{
|
|
Code: 500,
|
|
Message: errTrailer,
|
|
}
|
|
}
|
|
return nil
|
|
}
|