Blame internal/client/client.go

Packit 63bb0d
// Package client contains functions for communicating with the API server
Packit 63bb0d
// Copyright (C) 2020 by Red Hat, Inc.
Packit 63bb0d
package client
Packit 63bb0d
Packit 63bb0d
import (
Packit 63bb0d
	"bytes"
Packit 63bb0d
	"encoding/json"
Packit 63bb0d
	"errors"
Packit 63bb0d
	"fmt"
Packit 63bb0d
	"io"
Packit 63bb0d
	"io/ioutil"
Packit 63bb0d
	"net/http"
Packit 63bb0d
)
Packit 63bb0d
Packit 63bb0d
// Request handles sending the request, handling errors, returning the response
Packit 63bb0d
// socket is the path to a Unix Domain socket
Packit 63bb0d
// path is the full URL path, including query strings
Packit 63bb0d
// body is the data to send with POST
Packit 63bb0d
// headers is a map of header:value to add to the request
Packit 63bb0d
//
Packit 63bb0d
// If it is successful a http.Response will be returned. If there is an error, the response will be
Packit 63bb0d
// nil and error will be returned.
Packit 63bb0d
func Request(socket *http.Client, method, path, body string, headers map[string]string) (*http.Response, error) {
Packit 63bb0d
	req, err := http.NewRequest(method, "http://localhost"+path, bytes.NewReader([]byte(body)))
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	for h, v := range headers {
Packit 63bb0d
		req.Header.Set(h, v)
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	resp, err := socket.Do(req)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	return resp, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// APIErrorMsg is an individual API error with an ID and a message string
Packit 63bb0d
type APIErrorMsg struct {
Packit 63bb0d
	ID  string `json:"id"`
Packit 63bb0d
	Msg string `json:"msg"`
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// String returns the error id and message as a string
Packit 63bb0d
func (r *APIErrorMsg) String() string {
Packit 63bb0d
	return fmt.Sprintf("%s: %s", r.ID, r.Msg)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// APIResponse is returned by some requests to indicate success or failure.
Packit 63bb0d
// It is always returned when the status code is 400, indicating some kind of error with the request.
Packit 63bb0d
// If Status is true the Errors list will not be included or will be empty.
Packit 63bb0d
// When Status is false it will include at least one APIErrorMsg with details about the error.
Packit 63bb0d
type APIResponse struct {
Packit 63bb0d
	Status bool          `json:"status"`
Packit 63bb0d
	Errors []APIErrorMsg `json:"errors,omitempty"`
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// String returns the description of the first error, if there is one
Packit 63bb0d
func (r *APIResponse) String() string {
Packit 63bb0d
	if len(r.Errors) == 0 {
Packit 63bb0d
		return ""
Packit 63bb0d
	}
Packit 63bb0d
	return r.Errors[0].String()
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// AllErrors returns a list of error description strings
Packit 63bb0d
func (r *APIResponse) AllErrors() (all []string) {
Packit 63bb0d
	for i := range r.Errors {
Packit 63bb0d
		all = append(all, r.Errors[i].String())
Packit 63bb0d
	}
Packit 63bb0d
	return all
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// NewAPIResponse converts the response body to a status response
Packit 63bb0d
func NewAPIResponse(body []byte) (*APIResponse, error) {
Packit 63bb0d
	var status APIResponse
Packit 63bb0d
	err := json.Unmarshal(body, &status)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	return &status, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// apiError converts an API error 400 JSON to a status response
Packit 63bb0d
//
Packit 63bb0d
// The response body should alway be of the form:
Packit 63bb0d
//     {"status": false, "errors": [{"id": ERROR_ID, "msg": ERROR_MESSAGE}, ...]}
Packit 63bb0d
func apiError(resp *http.Response) (*APIResponse, error) {
Packit 63bb0d
	defer resp.Body.Close()
Packit 63bb0d
Packit 63bb0d
	body, err := ioutil.ReadAll(resp.Body)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, err
Packit 63bb0d
	}
Packit 63bb0d
	return NewAPIResponse(body)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// GetRawBody returns the resp.Body io.ReadCloser to the caller
Packit 63bb0d
// NOTE: The caller is responsible for closing the Body when finished
Packit 63bb0d
func GetRawBody(socket *http.Client, method, path string) (io.ReadCloser, *APIResponse, error) {
Packit 63bb0d
	resp, err := Request(socket, method, path, "", map[string]string{})
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	// Convert the API's JSON error response to an error type and return it
Packit 63bb0d
	// lorax-composer (wrongly) returns 404 for some of its json responses
Packit 63bb0d
	if resp.StatusCode == 400 || resp.StatusCode == 404 {
Packit 63bb0d
		apiResponse, err := apiError(resp)
Packit 63bb0d
		return nil, apiResponse, err
Packit 63bb0d
	}
Packit 63bb0d
	return resp.Body, nil, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// GetRaw returns raw data from a GET request
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func GetRaw(socket *http.Client, method, path string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	body, resp, err := GetRawBody(socket, method, path)
Packit 63bb0d
	if err != nil || resp != nil {
Packit 63bb0d
		return nil, resp, err
Packit 63bb0d
	}
Packit 63bb0d
	defer body.Close()
Packit 63bb0d
Packit 63bb0d
	bodyBytes, err := ioutil.ReadAll(body)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	return bodyBytes, nil, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// GetJSONAll returns all JSON results from a GET request using offset/limit
Packit 63bb0d
// This function makes 2 requests, the first with limit=0 to get the total number of results,
Packit 63bb0d
// and then with limit=TOTAL to fetch all of the results.
Packit 63bb0d
// The path passed to GetJSONAll should not include the limit or offset query parameters
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func GetJSONAll(socket *http.Client, path string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	body, api, err := GetRaw(socket, "GET", path+"?limit=0")
Packit 63bb0d
	if api != nil || err != nil {
Packit 63bb0d
		return nil, api, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	// We just want the total
Packit 63bb0d
	var j interface{}
Packit 63bb0d
	err = json.Unmarshal(body, &j)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
	m := j.(map[string]interface{})
Packit 63bb0d
	var v interface{}
Packit 63bb0d
	var ok bool
Packit 63bb0d
	if v, ok = m["total"]; !ok {
Packit 63bb0d
		return nil, nil, errors.New("Response is missing the total value")
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	switch total := v.(type) {
Packit 63bb0d
	case float64:
Packit 63bb0d
		allResults := fmt.Sprintf("%s?limit=%v", path, total)
Packit 63bb0d
		return GetRaw(socket, "GET", allResults)
Packit 63bb0d
	}
Packit 63bb0d
	return nil, nil, errors.New("Response 'total' is not a float64")
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// PostRaw sends a POST with raw data and returns the raw response body
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func PostRaw(socket *http.Client, path, body string, headers map[string]string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	resp, err := Request(socket, "POST", path, body, headers)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	// Convert the API's JSON error response to an APIResponse
Packit 63bb0d
	if resp.StatusCode == 400 {
Packit 63bb0d
		apiResponse, err := apiError(resp)
Packit 63bb0d
		return nil, apiResponse, err
Packit 63bb0d
	}
Packit 63bb0d
	defer resp.Body.Close()
Packit 63bb0d
Packit 63bb0d
	responseBody, err := ioutil.ReadAll(resp.Body)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	return responseBody, nil, nil
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// PostTOML sends a POST with TOML data and the Content-Type header set to "text/x-toml"
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func PostTOML(socket *http.Client, path, body string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	headers := map[string]string{"Content-Type": "text/x-toml"}
Packit 63bb0d
	return PostRaw(socket, path, body, headers)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// PostJSON sends a POST with JSON data and the Content-Type header set to "application/json"
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func PostJSON(socket *http.Client, path, body string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	headers := map[string]string{"Content-Type": "application/json"}
Packit 63bb0d
	return PostRaw(socket, path, body, headers)
Packit 63bb0d
}
Packit 63bb0d
Packit 63bb0d
// DeleteRaw sends a DELETE request
Packit 63bb0d
// Errors from the API are returned as an APIResponse, client errors are returned as error
Packit 63bb0d
func DeleteRaw(socket *http.Client, path string) ([]byte, *APIResponse, error) {
Packit 63bb0d
	resp, err := Request(socket, "DELETE", path, "", nil)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	// Convert the API's JSON error response to an APIResponse
Packit 63bb0d
	if resp.StatusCode == 400 {
Packit 63bb0d
		apiResponse, err := apiError(resp)
Packit 63bb0d
		return nil, apiResponse, err
Packit 63bb0d
	}
Packit 63bb0d
	defer resp.Body.Close()
Packit 63bb0d
Packit 63bb0d
	responseBody, err := ioutil.ReadAll(resp.Body)
Packit 63bb0d
	if err != nil {
Packit 63bb0d
		return nil, nil, err
Packit 63bb0d
	}
Packit 63bb0d
Packit 63bb0d
	return responseBody, nil, nil
Packit 63bb0d
}