Skip to content

Commit

Permalink
Delete bufbreakingcheck.newFieldDescriptorPairCheckFunc (#3234)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bufdev
bufdev authored Aug 12, 2024
1 parent b712a4f commit 6713034
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 52 deletions.
128 changes: 94 additions & 34 deletions private/bufpkg/bufcheck/bufbreaking/internal/bufbreakingcheck/bufbreakingcheck.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,16 +332,22 @@ func isDeletedFieldAllowedWithRules(previousField bufprotosource.Field, message
}

// CheckFieldSameCardinality is a check function.
var CheckFieldSameCardinality = newFieldDescriptorPairCheckFunc(checkFieldSameCardinality)
var CheckFieldSameCardinality = newFieldPairCheckFunc(checkFieldSameCardinality)

func checkFieldSameCardinality(
add addFunc,
_ *corpus,
_ bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
previousField bufprotosource.Field,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.ContainingMessage().IsMapEntry() && descriptor.ContainingMessage().IsMapEntry() {
// Map entries are generated so nothing to do here. They
// usually would be safe to check anyway, but it's possible
Expand All @@ -366,16 +372,22 @@ func checkFieldSameCardinality(
}

// CheckFieldSameCppStringType is a check function.
var CheckFieldSameCppStringType = newFieldDescriptorPairCheckFunc(checkFieldSameCppStringType)
var CheckFieldSameCppStringType = newFieldPairCheckFunc(checkFieldSameCppStringType)

func checkFieldSameCppStringType(
add addFunc,
corpus *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.ContainingMessage().IsMapEntry() && descriptor.ContainingMessage().IsMapEntry() {
// Map entries, even with string or bytes keys or values,
// don't allow configuring the string type.
Expand Down Expand Up @@ -422,16 +434,22 @@ func checkFieldSameCppStringType(
}

// CheckFieldSameJavaUTF8Validation is a check function.
var CheckFieldSameJavaUTF8Validation = newFieldDescriptorPairCheckFunc(checkFieldSameJavaUTF8Validation)
var CheckFieldSameJavaUTF8Validation = newFieldPairCheckFunc(checkFieldSameJavaUTF8Validation)

func checkFieldSameJavaUTF8Validation(
add addFunc,
corpus *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.Kind() != protoreflect.StringKind || descriptor.Kind() != protoreflect.StringKind {
// this check only applies to string fields
return nil
Expand Down Expand Up @@ -459,16 +477,22 @@ func checkFieldSameJavaUTF8Validation(
}

// CheckFieldSameDefault is a check function.
var CheckFieldSameDefault = newFieldDescriptorPairCheckFunc(checkFieldSameDefault)
var CheckFieldSameDefault = newFieldPairCheckFunc(checkFieldSameDefault)

func checkFieldSameDefault(
add addFunc,
corpus *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if !canHaveDefault(previousDescriptor) || !canHaveDefault(descriptor) {
return nil
}
Expand Down Expand Up @@ -610,16 +634,22 @@ func checkFieldSameOneof(add addFunc, corpus *corpus, previousField bufprotosour
}

// CheckFieldSameType is a check function.
var CheckFieldSameType = newFieldDescriptorPairCheckFunc(checkFieldSameType)
var CheckFieldSameType = newFieldPairCheckFunc(checkFieldSameType)

func checkFieldSameType(
add addFunc,
_ *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
// We use descriptor.Kind(), instead of field.Type(), because it also includes
// a check of resolved features in Editions files so it can distinguish between
// normal (length-prefixed) and delimited (aka "group" encoded) messages, which
Expand All @@ -641,16 +671,22 @@ func checkFieldSameType(
}

// CheckFieldSameUTF8Validation is a check function.
var CheckFieldSameUTF8Validation = newFieldDescriptorPairCheckFunc(checkFieldSameUTF8Validation)
var CheckFieldSameUTF8Validation = newFieldPairCheckFunc(checkFieldSameUTF8Validation)

func checkFieldSameUTF8Validation(
add addFunc,
_ *corpus,
_ bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
previousField bufprotosource.Field,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.Kind() != protoreflect.StringKind || descriptor.Kind() != protoreflect.StringKind {
return nil
}
Expand Down Expand Up @@ -683,16 +719,22 @@ func checkFieldSameUTF8Validation(
}

// CheckFieldWireCompatibleCardinality is a check function.
var CheckFieldWireCompatibleCardinality = newFieldDescriptorPairCheckFunc(checkFieldWireCompatibleCardinality)
var CheckFieldWireCompatibleCardinality = newFieldPairCheckFunc(checkFieldWireCompatibleCardinality)

func checkFieldWireCompatibleCardinality(
add addFunc,
_ *corpus,
_ bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
previousField bufprotosource.Field,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.ContainingMessage().IsMapEntry() && descriptor.ContainingMessage().IsMapEntry() {
// Map entries are generated so nothing to do here. They
// usually would be safe to check anyway, but it's possible
Expand All @@ -717,16 +759,22 @@ func checkFieldWireCompatibleCardinality(
}

// CheckFieldWireCompatibleType is a check function.
var CheckFieldWireCompatibleType = newFieldDescriptorPairCheckFunc(checkFieldWireCompatibleType)
var CheckFieldWireCompatibleType = newFieldPairCheckFunc(checkFieldWireCompatibleType)

func checkFieldWireCompatibleType(
add addFunc,
corpus *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
// We use descriptor.Kind(), instead of field.Type(), because it also includes
// a check of resolved features in Editions files so it can distinguish between
// normal (length-prefixed) and delimited (aka "group" encoded) messages, which
Expand Down Expand Up @@ -772,16 +820,22 @@ func checkFieldWireCompatibleType(
}

// CheckFieldWireJSONCompatibleCardinality is a check function.
var CheckFieldWireJSONCompatibleCardinality = newFieldDescriptorPairCheckFunc(checkFieldWireJSONCompatibleCardinality)
var CheckFieldWireJSONCompatibleCardinality = newFieldPairCheckFunc(checkFieldWireJSONCompatibleCardinality)

func checkFieldWireJSONCompatibleCardinality(
add addFunc,
_ *corpus,
_ bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
previousField bufprotosource.Field,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
if previousDescriptor.ContainingMessage().IsMapEntry() && descriptor.ContainingMessage().IsMapEntry() {
// Map entries are generated so nothing to do here. They
// usually would be safe to check anyway, but it's possible
Expand All @@ -806,16 +860,22 @@ func checkFieldWireJSONCompatibleCardinality(
}

// CheckFieldWireJSONCompatibleType is a check function.
var CheckFieldWireJSONCompatibleType = newFieldDescriptorPairCheckFunc(checkFieldWireJSONCompatibleType)
var CheckFieldWireJSONCompatibleType = newFieldPairCheckFunc(checkFieldWireJSONCompatibleType)

func checkFieldWireJSONCompatibleType(
add addFunc,
corpus *corpus,
previousField bufprotosource.Field,
previousDescriptor protoreflect.FieldDescriptor,
field bufprotosource.Field,
descriptor protoreflect.FieldDescriptor,
) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
// We use descriptor.Kind(), instead of field.Type(), because it also includes
// a check of resolved features in Editions files so it can distinguish between
// normal (length-prefixed) and delimited (aka "group" encoded) messages, which
Expand Down
18 changes: 0 additions & 18 deletions private/bufpkg/bufcheck/bufbreaking/internal/bufbreakingcheck/util.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,24 +302,6 @@ func newFieldPairCheckFunc(
)
}

func newFieldDescriptorPairCheckFunc(
f func(addFunc, *corpus, bufprotosource.Field, protoreflect.FieldDescriptor, bufprotosource.Field, protoreflect.FieldDescriptor) error,
) func(string, internal.IgnoreFunc, []bufprotosource.File, []bufprotosource.File) ([]bufanalysis.FileAnnotation, error) {
return newFieldPairCheckFunc(
func(add addFunc, corpus *corpus, previousField bufprotosource.Field, field bufprotosource.Field) error {
previousDescriptor, err := previousField.AsDescriptor()
if err != nil {
return err
}
descriptor, err := field.AsDescriptor()
if err != nil {
return err
}
return f(add, corpus, previousField, previousDescriptor, field, descriptor)
},
)
}

func newServicePairCheckFunc(
f func(addFunc, *corpus, bufprotosource.Service, bufprotosource.Service) error,
) func(string, internal.IgnoreFunc, []bufprotosource.File, []bufprotosource.File) ([]bufanalysis.FileAnnotation, error) {
Expand Down

0 comments on commit 6713034

Please sign in to comment.