// SPDX-License-Identifier: Apache-2.0 // // The OpenSearch Contributors require contributions made to // this file be licensed under the Apache-2.0 license or a // compatible open source license. // // Modifications Copyright OpenSearch Contributors. See // GitHub history for details. // Licensed to Elasticsearch B.V. under one or more contributor // license agreements. See the NOTICE file distributed with // this work for additional information regarding copyright // ownership. Elasticsearch B.V. licenses this file to you under // the Apache License, Version 2.0 (the "License"); you may // not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. package opensearchapi import ( "bytes" "encoding/json" "fmt" "io" "io/ioutil" "net/http" "reflect" "strconv" "strings" ) // Response represents the API response. type Response struct { StatusCode int Header http.Header Body io.ReadCloser } // String returns the response as a string. // // The intended usage is for testing or debugging only. func (r *Response) String() string { var ( out = new(bytes.Buffer) b1 = bytes.NewBuffer([]byte{}) b2 = bytes.NewBuffer([]byte{}) tr io.Reader ) if r != nil && r.Body != nil { tr = io.TeeReader(r.Body, b1) defer r.Body.Close() if _, err := io.Copy(b2, tr); err != nil { out.WriteString(fmt.Sprintf("", err)) return out.String() } defer func() { r.Body = ioutil.NopCloser(b1) }() } if r != nil { out.WriteString(fmt.Sprintf("[%d %s]", r.StatusCode, http.StatusText(r.StatusCode))) if r.StatusCode > 0 { out.WriteRune(' ') } } else { out.WriteString("[0 ]") } if r != nil && r.Body != nil { out.ReadFrom(b2) // errcheck exclude (*bytes.Buffer).ReadFrom } return out.String() } // Status returns the response status as a string. func (r *Response) Status() string { var b strings.Builder if r != nil { b.WriteString(strconv.Itoa(r.StatusCode)) b.WriteString(" ") b.WriteString(http.StatusText(r.StatusCode)) } return b.String() } // IsError returns true when the response status indicates failure. func (r *Response) IsError() bool { return r.StatusCode > 299 } // Warnings returns the deprecation warnings from response headers. func (r *Response) Warnings() []string { return r.Header["Warning"] } // HasWarnings returns true when the response headers contain deprecation warnings. func (r *Response) HasWarnings() bool { return len(r.Warnings()) > 0 } // Err returns an error when the response status indicates failures. func (r *Response) Err() error { if r.IsError() { if r.Body == nil { return fmt.Errorf(r.Status()) } body, err := io.ReadAll(r.Body) if err != nil { return fmt.Errorf(r.Status()) } var e *Error err = json.Unmarshal(body, &e) if err == nil && !reflect.ValueOf(e.Err).IsZero() { return e } return fmt.Errorf("status: %d, error: %s", r.StatusCode, string(body)) } return nil }