Skip to content

Commit

Permalink
use strongly-typed struct for errJSON
Browse files Browse the repository at this point in the history 
Signed-off-by: Cassandra Coyle <[email protected]>
  • Loading branch information
@cicoyle
cicoyle committed Dec 1, 2023
1 parent b420732 commit ddf45fb
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 128 deletions.
58 changes: 27 additions & 31 deletions errors/errors.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func (e *Error) Error() string {
return ""
}

// String returns the string representation, useful for debugging.
// String returns the string representation.
func (e Error) String() string {
return fmt.Sprintf(errStringFormat, e.GrpcCode.String(), e.Message)
}
Expand Down Expand Up @@ -103,14 +103,6 @@ func (e *Error) WithErrorInfo(reason string, metadata map[string]string) *Error
return e
}

// WithVars returns a copy of the error with the message going through fmt.Sprintf with the arguments passed to this method.
func (e *Error) WithVars(a ...any) *Error {
eCopy := *e
eCopy.Message = fmt.Sprintf(e.Message, a...)

return &eCopy
}

func (e *Error) WithDetails(details ...proto.Message) *Error {
e.Details = append(e.Details, details...)

Expand Down Expand Up @@ -142,11 +134,16 @@ func (e *Error) GRPCStatus() *status.Status {
}

return stat

}

// *** HTTP Methods ***

type ErrorJSON struct {
ErrorCode string `json:"errorCode"`
Message string `json:"message"`
Details []any `json:"details,omitempty"`
}

// JSONErrorValue implements the errorResponseValue interface.
func (e *Error) JSONErrorValue() []byte {
grpcStatus := e.GRPCStatus().Proto()
Expand All @@ -160,16 +157,15 @@ func (e *Error) JSONErrorValue() []byte {
httpStatus = http.StatusText(e.HttpCode)
}

// Change output to match prior output to not break users
errJson := map[string]interface{}{
"errorCode": httpStatus,
"message": grpcStatus.GetMessage(),
errJson := ErrorJSON{

Check warning on line 160 in errors/errors.go

View workflow job for this annotation

GitHub Actions / Build linux_amd64 binaries 

var-naming: var errJson should be errJSON (revive)
ErrorCode: httpStatus,
Message: grpcStatus.GetMessage(),
}

// Handle err details
details := e.Details
if len(details) > 0 {
errJson["details"] = make([]interface{}, len(details))
errJson.Details = make([]any, len(details))
for i, detail := range details {
// cast to interface to be able to do type switch
// over all possible error_details defined
Expand All @@ -183,56 +179,56 @@ func (e *Error) JSONErrorValue() []byte {
"domain": typedDetail.Domain,

Check failure on line 179 in errors/errors.go

View workflow job for this annotation

GitHub Actions / Build linux_amd64 binaries 

avoid direct access to proto field typedDetail.Domain, use typedDetail.GetDomain() instead (protogetter)
"metadata": typedDetail.Metadata,

Check failure on line 180 in errors/errors.go

View workflow job for this annotation

GitHub Actions / Build linux_amd64 binaries 

avoid direct access to proto field typedDetail.Metadata, use typedDetail.GetMetadata() instead (protogetter)
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap

// If there is an ErrorInfo Reason, but no legacy Tag code, use the ErrorInfo Reason as the error code
if e.Tag == "" && typedDetail.Reason != "" {

Check failure on line 185 in errors/errors.go

View workflow job for this annotation

GitHub Actions / Build linux_amd64 binaries 

avoid direct access to proto field typedDetail.Reason, use typedDetail.GetReason() instead (protogetter)
errJson["errorCode"] = typedDetail.Reason
errJson.ErrorCode = typedDetail.Reason

Check failure on line 186 in errors/errors.go

View workflow job for this annotation

GitHub Actions / Build linux_amd64 binaries 

avoid direct access to proto field typedDetail.Reason, use typedDetail.GetReason() instead (protogetter)
}
case *errdetails.RetryInfo:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"retry_delay": typedDetail.RetryDelay,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.DebugInfo:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"stack_entries": typedDetail.StackEntries,
"detail": typedDetail.Detail,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.QuotaFailure:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"violations": typedDetail.Violations,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.PreconditionFailure:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"violations": typedDetail.Violations,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.BadRequest:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"field_violations": typedDetail.FieldViolations,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.RequestInfo:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"request_id": typedDetail.RequestId,
"serving_data": typedDetail.ServingData,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.ResourceInfo:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
Expand All @@ -242,30 +238,30 @@ func (e *Error) JSONErrorValue() []byte {
"owner": typedDetail.Owner,
"description": typedDetail.Description,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.Help:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"links": typedDetail.Links,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.LocalizedMessage:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"locale": typedDetail.Locale,
"message": typedDetail.Message,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.QuotaFailure_Violation:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"subject": typedDetail.Subject,
"description": typedDetail.Description,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.PreconditionFailure_Violation:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
Expand All @@ -274,31 +270,31 @@ func (e *Error) JSONErrorValue() []byte {
"description": typedDetail.Description,
"type": typedDetail.Type,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.BadRequest_FieldViolation:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"field": typedDetail.Field,
"description": typedDetail.Description,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
case *errdetails.Help_Link:
desc := typedDetail.ProtoReflect().Descriptor()
detailMap := map[string]interface{}{
"@type": typeGoogleAPI + desc.FullName(),
"description": typedDetail.Description,
"url": typedDetail.Url,
}
errJson["details"].([]interface{})[i] = detailMap
errJson.Details[i] = detailMap
default:
log.Debugf("Failed to convert error details due to incorrect type. \nSee types here: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto. \nDetail: %s", detail)
// Handle unknown detail types
unknownDetail := map[string]interface{}{
"unknownDetailType": fmt.Sprintf("%T", typedDetail),
"unknownDetails": fmt.Sprintf("%#v", typedDetail),
}
errJson["details"].([]interface{})[i] = unknownDetail
errJson.Details[i] = unknownDetail
}
}
}
Expand Down
97 changes: 0 additions & 97 deletions errors/errors_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,103 +29,6 @@ import (
"google.golang.org/protobuf/proto"
)

/*
//TODO confirm - do we still want this functionality: WithVars?
*/
func TestError_WithVars(t *testing.T) {
type fields struct {
details []proto.Message
grpcCode grpcCodes.Code
httpCode int
message string
tag string
}

type args struct {
a []any
}

tests := []struct {
name string
fields fields
args args
want Error
}{
{
name: "No_Formatting",
fields: fields{
details: []proto.Message{},
grpcCode: grpcCodes.ResourceExhausted,
httpCode: http.StatusTeapot,
message: "fake_message",
tag: "DAPR_FAKE_TAG",
},
args: args{a: []any{}},
want: Error{
Details: []proto.Message{},
GrpcCode: grpcCodes.ResourceExhausted,
HttpCode: http.StatusTeapot,
Message: "fake_message",
Tag: "DAPR_FAKE_TAG",
},
},
{
name: "String_Parameter",
fields: fields{
details: []proto.Message{},
grpcCode: grpcCodes.ResourceExhausted,
httpCode: http.StatusTeapot,
message: "fake_message: %s",
tag: "DAPR_FAKE_TAG",
},
args: args{a: []any{"myFakeMsg"}},
want: Error{
Details: []proto.Message{},
GrpcCode: grpcCodes.ResourceExhausted,
HttpCode: http.StatusTeapot,
Message: "fake_message: myFakeMsg",
Tag: "DAPR_FAKE_TAG",
},
},
{
name: "Multiple_Parameters",
fields: fields{
details: []proto.Message{},
grpcCode: grpcCodes.ResourceExhausted,
httpCode: http.StatusTeapot,
message: "fake_messages: %s, %s, %d",
tag: "DAPR_FAKE_TAG",
},
args: args{a: []any{"myFakeMsg1", "myFakeMsg2", 12}},
want: Error{
Details: []proto.Message{},
GrpcCode: grpcCodes.ResourceExhausted,
HttpCode: http.StatusTeapot,
Message: "fake_messages: myFakeMsg1, myFakeMsg2, 12",
Tag: "DAPR_FAKE_TAG",
},
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
kitErr := Error{
Details: test.fields.details,
GrpcCode: test.fields.grpcCode,
HttpCode: test.fields.httpCode,
Message: test.fields.message,
Tag: test.fields.tag,
}

if got := kitErr.WithVars(test.args.a...); !reflect.DeepEqual(got, &test.want) {
t.Errorf("Error.WithVars() = %v, want %v\n", got, test.want)
}

assert.True(t, kitErr.Is(&kitErr))
})
}
}

func TestError_Message(t *testing.T) {
type fields struct {
message string
Expand Down

0 comments on commit ddf45fb

Please sign in to comment.