Revert "Merge pull request #1 from infobloxopen/master"

This reverts commit 8c8311f, reversing
changes made to e18a59a.

Author: molon

gateway/errors.go

@@ -2,20 +2,12 @@ package gateway
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"io"
-	"math"
 	"net/http"
-	"strconv"
-	"strings"
-	"sync/atomic"
-	"time"
 
-	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/grpclog"
-	"google.golang.org/grpc/metadata"
 	"google.golang.org/grpc/status"
 
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
@@ -28,8 +20,12 @@ import (
 // Addition bool argument indicates whether method (http.ResponseWriter.WriteHeader) was called or not.
 type ProtoStreamErrorHandlerFunc func(context.Context, bool, *runtime.ServeMux, runtime.Marshaler, http.ResponseWriter, *http.Request, error)
 
-type RestErrs struct {
-	Error []map[string]interface{} `json:"error,omitempty"`
+// RestError represents an error in accordance with REST API Syntax Specification.
+// See: https://github.com/infobloxopen/atlas-app-toolkit#errors
+type RestError struct {
+	Status  *RestStatus   `json:"error,omitempty"`
+	Details []interface{} `json:"details,omitempty"`
+	Fields  interface{}   `json:"fields,omitempty"`
 }
 
 var (
@@ -110,28 +106,19 @@ func (h *ProtoErrorHandler) writeError(ctx context.Context, headerWritten bool,
 		}
 	}
 
-	restErr := map[string]interface{}{
-		"message": st.Message(),
-	}
-	if len(details) > 0 {
-		restErr["details"] = details
-	}
-	if fields != nil {
-		restErr["fields"] = fields
+	restErr := &RestError{
+		Status:  Status(ctx, st),
+		Details: details,
+		Fields:  fields,
 	}
 
-	errs, _ := errorsAndSuccessFromContext(ctx)
-	restResp := &RestErrs{
-		Error: errs,
-	}
-	restResp.Error = append(restResp.Error, restErr)
 	if !headerWritten {
 		rw.Header().Del("Trailer")
 		rw.Header().Set("Content-Type", marshaler.ContentType())
-		rw.WriteHeader(HTTPStatus(ctx, st))
+		rw.WriteHeader(restErr.Status.HTTPStatus)
 	}
 
-	buf, merr := marshaler.Marshal(restResp)
+	buf, merr := marshaler.Marshal(restErr)
 	if merr != nil {
 		grpclog.Infof("error handler: failed to marshal error message %q: %v", restErr, merr)
 		rw.WriteHeader(http.StatusInternalServerError)
@@ -146,125 +133,3 @@ func (h *ProtoErrorHandler) writeError(ctx context.Context, headerWritten bool,
 		grpclog.Infof("error handler: failed to write response: %v", err)
 	}
 }
-
-// For small performance bump, switch map[string]string to a tuple-type (string, string)
-
-type MessageWithFields interface {
-	error
-	GetFields() map[string]interface{}
-	GetMessage() string
-}
-type messageWithFields struct {
-	message string
-	fields  map[string]interface{}
-}
-
-func (m *messageWithFields) Error() string {
-	return m.message
-}
-func (m *messageWithFields) GetFields() map[string]interface{} {
-	return m.fields
-}
-func (m *messageWithFields) GetMessage() string {
-	return m.message
-}
-
-// NewWithFields returns a new MessageWithFields that requires a message string,
-// and then treats the following arguments as alternating keys and values
-// a non-string key will immediately return the result so far, ignoring later
-// values. The values can be any type
-func NewWithFields(message string, kvpairs ...interface{}) MessageWithFields {
-	mwf := &messageWithFields{message: message, fields: make(map[string]interface{})}
-	for i := 0; i+1 < len(kvpairs); i += 2 {
-		k, ok := kvpairs[i].(string)
-		if !ok {
-			return mwf
-		}
-		mwf.fields[k] = kvpairs[i+1]
-	}
-	return mwf
-}
-
-// For giving each error a unique metadata key, but not leaking the exact count
-// of errors or something like that
-var counter *uint32
-
-func init() {
-	counter = new(uint32)
-	*counter = uint32(time.Now().Nanosecond() % math.MaxUint32)
-}
-
-// WithError will save an error message into the grpc trailer metadata, if it
-// is an error that implements MessageWithFields, it also saves the fields.
-// This error will then be inserted into the return JSON if the ResponseForwarder
-// is used
-func WithError(ctx context.Context, err error) {
-	i := atomic.AddUint32(counter, uint32(time.Now().Nanosecond()%100+1))
-	md := metadata.Pairs(fmt.Sprintf("error-%d", i), fmt.Sprintf("message:%s", err.Error()))
-	if mwf, ok := err.(MessageWithFields); ok {
-		if f := mwf.GetFields(); f != nil {
-			b, _ := json.Marshal(mwf.GetFields())
-			md.Append(fmt.Sprintf("error-%d", i), fmt.Sprintf("fields:%q", b))
-		}
-	}
-	grpc.SetTrailer(ctx, md)
-}
-
-// WithSuccess will save a MessageWithFields into the grpc trailer metadata.
-// This success message will then be inserted into the return JSON if the
-// ResponseForwarder is used
-func WithSuccess(ctx context.Context, msg MessageWithFields) {
-	i := atomic.AddUint32(counter, uint32(time.Now().Nanosecond()%100+1))
-	md := metadata.Pairs(fmt.Sprintf("success-%d", i), fmt.Sprintf("message:%s", msg.Error()))
-	if f := msg.GetFields(); f != nil {
-		b, _ := json.Marshal(msg.GetFields())
-		md.Append(fmt.Sprintf("success-%d", i), fmt.Sprintf("fields:%q", b))
-	}
-	grpc.SetTrailer(ctx, md)
-}
-
-func errorsAndSuccessFromContext(ctx context.Context) (errors []map[string]interface{}, success map[string]interface{}) {
-	md, ok := runtime.ServerMetadataFromContext(ctx)
-	if !ok {
-		return nil, nil
-	}
-	errors = make([]map[string]interface{}, 0)
-	latestSuccess := int64(-1)
-	for k, vs := range md.TrailerMD {
-		if strings.HasPrefix(k, "error-") {
-			err := make(map[string]interface{})
-			for _, v := range vs {
-				parts := strings.SplitN(v, ":", 2)
-				if parts[0] == "fields" {
-					uq, _ := strconv.Unquote(parts[1])
-					json.Unmarshal([]byte(uq), &err)
-				} else if parts[0] == "message" {
-					err["message"] = parts[1]
-				}
-			}
-			errors = append(errors, err)
-		}
-		if num := strings.TrimPrefix(k, "success-"); num != k {
-			// Let the later success messages override previous ones,
-			// also account for the possiblity of wraparound with a generous check
-			if i, err := strconv.ParseInt(num, 10, 32); err == nil {
-				if i > latestSuccess || (i < 1<<12 && latestSuccess > 1<<28) {
-					latestSuccess = i
-				} else {
-					continue
-				}
-			}
-			success = make(map[string]interface{})
-			for _, v := range vs {
-				parts := strings.SplitN(v, ":", 2)
-				if parts[0] == "fields" {
-					uq, _ := strconv.Unquote(parts[1])
-					json.Unmarshal([]byte(uq), &success)
-				} else if parts[0] == "message" {
-					success["message"] = parts[1]
-				}
-			}
-		}
-	}
-	return
-}

gateway/errors_test.go

@@ -12,13 +12,14 @@ import (
 	"github.com/infobloxopen/atlas-app-toolkit/errors"
 
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
+	"google.golang.org/genproto/googleapis/rpc/code"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 )
 
 func TestProtoMessageErrorHandlerUnknownCode(t *testing.T) {
 	err := fmt.Errorf("simple text error")
-	v := &RestErrs{}
+	v := new(RestError)
 
 	rw := httptest.NewRecorder()
 	ProtoMessageErrorHandler(context.Background(), nil, &runtime.JSONBuiltin{}, rw, nil, err)
@@ -34,14 +35,22 @@ func TestProtoMessageErrorHandlerUnknownCode(t *testing.T) {
 		t.Fatalf("failed to unmarshal response: %s", err)
 	}
 
-	if v.Error[0]["message"] != "simple text error" {
-		t.Errorf("invalid message: %s", v.Error[0]["message"])
+	if v.Status.HTTPStatus != http.StatusInternalServerError {
+		t.Errorf("invalid http status: %d", v.Status.HTTPStatus)
+	}
+
+	if v.Status.Code != code.Code_UNKNOWN.String() {
+		t.Errorf("invalid code: %s", v.Status.Code)
+	}
+
+	if v.Status.Message != "simple text error" {
+		t.Errorf("invalid message: %s", v.Status.Message)
 	}
 }
 
 func TestProtoMessageErrorHandlerUnimplementedCode(t *testing.T) {
 	err := status.Error(codes.Unimplemented, "service not implemented")
-	v := new(RestErrs)
+	v := new(RestError)
 
 	rw := httptest.NewRecorder()
 	ProtoMessageErrorHandler(context.Background(), nil, &runtime.JSONBuiltin{}, rw, nil, err)
@@ -57,8 +66,16 @@ func TestProtoMessageErrorHandlerUnimplementedCode(t *testing.T) {
 		t.Fatalf("failed to unmarshal response: %s", err)
 	}
 
-	if v.Error[0]["message"] != "service not implemented" {
-		t.Errorf("invalid message: %s", v.Error[0]["message"])
+	if v.Status.HTTPStatus != http.StatusNotImplemented {
+		t.Errorf("invalid http status: %d", v.Status.HTTPStatus)
+	}
+
+	if v.Status.Code != "NOT_IMPLEMENTED" {
+		t.Errorf("invalid code: %s", v.Status.Code)
+	}
+
+	if v.Status.Message != "service not implemented" {
+		t.Errorf("invalid message: %s", v.Status.Message)
 	}
 }
 
@@ -69,7 +86,7 @@ func TestWriteErrorContainer(t *testing.T) {
 		WithDetail(codes.AlreadyExists, "resource", "x btw already exists.").
 		WithField("x", "Check correct value of 'x'.")
 
-	v := new(RestErrs)
+	v := new(RestError)
 
 	rw := httptest.NewRecorder()
 	ProtoMessageErrorHandler(context.Background(), nil, &runtime.JSONBuiltin{}, rw, nil, err)
@@ -78,12 +95,20 @@ func TestWriteErrorContainer(t *testing.T) {
 		t.Fatalf("failed to unmarshal response: %s", err)
 	}
 
-	if v.Error[0]["message"] != "Invalid 'x' value." {
-		t.Errorf("invalid message: %s", v.Error[0]["message"])
+	if v.Status.HTTPStatus != http.StatusBadRequest {
+		t.Errorf("invalid http status: %d", v.Status.HTTPStatus)
+	}
+
+	if v.Status.Code != "INVALID_ARGUMENT" {
+		t.Errorf("invalid code: %s", v.Status.Code)
+	}
+
+	if v.Status.Message != "Invalid 'x' value." {
+		t.Errorf("invalid message: %s", v.Status.Message)
 	}
 
-	if len(v.Error[0]["details"].([]interface{})) != 2 {
-		t.Errorf("invalid details length: %d", len(v.Error[0]["details"].([]interface{})))
+	if len(v.Details) != 2 {
+		t.Errorf("invalid details length: %d", len(v.Details))
 	}
 
 	details := []interface{}{
@@ -100,19 +125,19 @@ func TestWriteErrorContainer(t *testing.T) {
 	}
 
 	if !reflect.DeepEqual(
-		v.Error[0]["details"],
+		v.Details,
 		details,
 	) {
-		t.Errorf("invalid details value: %v", v.Error[0]["details"])
+		t.Errorf("invalid details value: %v", v.Details)
 	}
 
 	fields := map[string][]string{
 		"x": []string{"Check correct value of 'x'."}}
 
-	vMap := v.Error[0]["fields"].(map[string]interface{})
+	vMap := v.Fields.(map[string]interface{})
 
 	if vMap["x"].([]interface{})[0] != fields["x"][0] {
-		t.Errorf("invalid fields value: %v", v.Error[0]["fields"])
+		t.Errorf("invalid fields value: %v", v.Fields)
 	}
 
 }

gateway/header.go

@@ -100,9 +100,6 @@ func handleForwardResponseServerMetadata(matcher runtime.HeaderMatcherFunc, w ht
 
 func handleForwardResponseTrailerHeader(w http.ResponseWriter, md runtime.ServerMetadata) {
 	for k := range md.TrailerMD {
-		if strings.HasPrefix(k, "error-") || strings.HasPrefix(k, "success-") {
-			continue
-		}
 		tKey := textproto.CanonicalMIMEHeaderKey(fmt.Sprintf("%s%s", runtime.MetadataTrailerPrefix, k))
 		w.Header().Add("Trailer", tKey)
 	}