From 5b71aa6212768326369fd6ba3e08829396ff921d Mon Sep 17 00:00:00 2001 From: Johan Brandhorst-Satzkorn Date: Fri, 8 Apr 2022 18:37:20 -0400 Subject: [PATCH] refact(subtype): Remove copied structToProto methods The original idea was for these methods to eventually become entirely encapsulated by the subtype package, but as it turns out we still have use for them in custom transformation functions, so move the subtype package to use these shared functions instead. --- .../types/subtypes/attribute_transform.go | 50 ++----------------- internal/types/subtypes/interceptor_test.go | 5 +- 2 files changed, 8 insertions(+), 47 deletions(-) diff --git a/internal/types/subtypes/attribute_transform.go b/internal/types/subtypes/attribute_transform.go index ab4793047..dbc38668b 100644 --- a/internal/types/subtypes/attribute_transform.go +++ b/internal/types/subtypes/attribute_transform.go @@ -3,7 +3,7 @@ package subtypes import ( "fmt" - "google.golang.org/protobuf/encoding/protojson" + "github.com/hashicorp/boundary/internal/servers/controller/handlers" "google.golang.org/protobuf/proto" "google.golang.org/protobuf/reflect/protoreflect" "google.golang.org/protobuf/types/known/structpb" @@ -43,7 +43,7 @@ func convertAttributesToSubtype(msg proto.Message, st Subtype) error { return fmt.Errorf("found default attribute field that is not structpb.Struct: %s %s", d.FullName(), defaultAttrField.FullName()) } stAttrs := r.Get(stAttrField).Message().New().Interface() - if err := structToProto(defaultAttrs, stAttrs); err != nil { + if err := handlers.StructToProto(defaultAttrs, stAttrs); err != nil { return err } @@ -82,7 +82,7 @@ func convertAttributesToDefault(msg proto.Message, st Subtype) error { if !ok { return fmt.Errorf("found subtype attribute field that is not proto.Message: %s %s", d.FullName(), stAttrField.FullName()) } - defaultAttrs, err := protoToStruct(stAttrs) + defaultAttrs, err := handlers.ProtoToStruct(stAttrs) if err != nil { return err } @@ -91,46 +91,6 @@ func convertAttributesToDefault(msg proto.Message, st Subtype) error { return nil } -func structToProto(fields *structpb.Struct, p proto.Message) error { - if fields == nil { - // If there is no struct, don't update the default proto message. - return nil - } - js, err := fields.MarshalJSON() - if err != nil { - return err - } - - // TODO: replicate this logic but with a proto extension set on the Field - // descriptor There are some attributes where we want to discard unknown - // fields, while others that should error if there are unknown fields - // - // opts := GetOpts(opt...) - // if opts.withDiscardUnknownFields { - // err = (protojson.UnmarshalOptions{DiscardUnknown: true}.Unmarshal(js, p)) - // } else { - // err = protojson.Unmarshal(js, p) - // } - - err = protojson.Unmarshal(js, p) - if err != nil { - return err - } - return nil -} - -func protoToStruct(p proto.Message) (*structpb.Struct, error) { - js, err := protojson.MarshalOptions{UseProtoNames: true}.Marshal(p) - if err != nil { - return nil, err - } - st := &structpb.Struct{} - if err := protojson.Unmarshal(js, st); err != nil { - return nil, err - } - return st, nil -} - // Filterable converts a proto.Message so any subtype attributes fields are // structed like the API so filter strings will be correctly applied. If the // given proto.Message does not have any subtype attributes, the original @@ -174,13 +134,13 @@ func Filterable(item proto.Message) (proto.Message, error) { } attr = r.Get(oneofField).Message().Interface() - pbAttrs, err = protoToStruct(attr) + pbAttrs, err = handlers.ProtoToStruct(attr) if err != nil { return nil, err } r.Set(defaultAttrField, protoreflect.ValueOfMessage(pbAttrs.ProtoReflect())) - f, err := protoToStruct(r.Interface()) + f, err := handlers.ProtoToStruct(r.Interface()) if err != nil { return nil, err } diff --git a/internal/types/subtypes/interceptor_test.go b/internal/types/subtypes/interceptor_test.go index 086ada728..58f039add 100644 --- a/internal/types/subtypes/interceptor_test.go +++ b/internal/types/subtypes/interceptor_test.go @@ -5,6 +5,7 @@ import ( "github.com/google/go-cmp/cmp" "github.com/hashicorp/boundary/internal/gen/testing/attribute" + "github.com/hashicorp/boundary/internal/servers/controller/handlers" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "google.golang.org/protobuf/proto" @@ -597,7 +598,7 @@ func TestCustomTransformRequest(t *testing.T) { require.True(t, ok, "wrong message passed to request transformation callback") if msg.SomeRandomId == "some_random_id" && msg.SecondaryId == "secondary_id" { newAttrs := &attribute.TestSubResourceAttributes{} - err := structToProto(msg.GetAttributes(), newAttrs) + err := handlers.StructToProto(msg.GetAttributes(), newAttrs) require.NoError(t, err) msg.Attrs = &attribute.TestCustomTransformation_SubResourceAttributes{ SubResourceAttributes: newAttrs, @@ -640,7 +641,7 @@ func TestCustomTransformResponse(t *testing.T) { msg, ok := m.(*attribute.TestCustomTransformation) require.True(t, ok, "wrong message passed to response transformation callback") if msg.SomeRandomId == "some_random_id" && msg.SecondaryId == "secondary_id" { - newAttrs, err := protoToStruct(msg.GetSubResourceAttributes()) + newAttrs, err := handlers.ProtoToStruct(msg.GetSubResourceAttributes()) require.NoError(t, err) msg.Attrs = &attribute.TestCustomTransformation_Attributes{ Attributes: newAttrs,