Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc string for WKT scalars #75

Merged
merged 2 commits into from
Sep 25, 2023
Merged

Add doc string for WKT scalars #75

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8452c64
Add doc string for WKT scalars
emcfarlane Sep 25, 2023
d304449
Fix name of WKT and ignore goconst
emcfarlane Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions params.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//nolint:goconst
package vanguard

import (
Expand All @@ -29,33 +30,33 @@ import (
"google.golang.org/protobuf/reflect/protoreflect"
)

//nolint:gochecknoglobals
var isScalarWellKnownType = map[protoreflect.FullName]bool{
"google.protobuf.Duration": true,
"google.protobuf.Empty": true,
"google.protobuf.FieldMask": true,
"google.protobuf.Timestamp": true,
"google.protobuf.NullValue": true,
"google.protobuf.StringValue": true,
"google.protobuf.BytesValue": true,
"google.protobuf.Int32Value": true,
"google.protobuf.Int64Value": true,
"google.protobuf.UInt32Value": true,
"google.protobuf.UInt64Value": true,
"google.protobuf.FloatValue": true,
"google.protobuf.DoubleValue": true,
"google.protobuf.BoolValue": true,
}

// isParameterType returns true if the field is a primitive type, or a
// well-known-type that can be represented as a scalar in JSON.
// These are valid leaf fields for use in URL paths and query parameters.
func isParameterType(field protoreflect.FieldDescriptor) bool {
kind := field.Kind()
return kind != protoreflect.GroupKind &&
(kind != protoreflect.MessageKind || isScalarWKT(field))
(kind != protoreflect.MessageKind || isWKTWithScalarJSONMapping(field))
}

func isScalarWKT(field protoreflect.FieldDescriptor) bool {
return field.Kind() == protoreflect.MessageKind &&
isScalarWellKnownType[field.Message().FullName()]
// isWKTWithScalarJSONMapping returns true if the field is a well-known type that
// maps to a scalar JSON type. These are also valid parameter types alongside
// primitives.
func isWKTWithScalarJSONMapping(field protoreflect.FieldDescriptor) bool {
const wellKnownTypePrefix = "google.protobuf."
if field.Kind() != protoreflect.MessageKind || !strings.HasPrefix(
string(field.Message().FullName()), wellKnownTypePrefix,
) {
return false
}
switch field.Message().Name() {
case "BoolValue", "BytesValue", "DoubleValue", "Duration", "Empty",
"FieldMask", "FloatValue", "Int32Value", "Int64Value", "NullValue",
"StringValue", "Timestamp", "UInt32Value", "UInt64Value":
return true
default:
return false
}
}

// setParameter sets the value of a field on a message using the ident fields.
Expand Down Expand Up @@ -177,7 +178,7 @@ func unmarshalFieldValue(msg protoreflect.Message, field protoreflect.FieldDescr

// unmarshalFieldWKT unmarshals well known JSON scalars to their message types.
func unmarshalFieldWKT(msg protoreflect.Message, field protoreflect.FieldDescriptor, data []byte) (protoreflect.Value, error) {
if !isScalarWKT(field) {
if !isWKTWithScalarJSONMapping(field) {
return protoreflect.Value{}, fmt.Errorf("unsupported message type %s", field.Message().FullName())
}
switch field.Message().Name() {
Expand Down Expand Up @@ -308,7 +309,7 @@ func marshalFieldValue(field protoreflect.FieldDescriptor, value protoreflect.Va
}

func marshalFieldWKT(field protoreflect.FieldDescriptor, value protoreflect.Value) ([]byte, error) {
if !isScalarWKT(field) {
if !isWKTWithScalarJSONMapping(field) {
return nil, fmt.Errorf("unsupported message type %s", field.Message().FullName())
}
msgName := field.Message().Name()
Expand Down