Refactor the API for v1 (#173)

Co-authored-by: bufdev <[email protected]>

Author: jchadwick-buf

.golangci.yml

@@ -64,15 +64,15 @@ issues:
         - varnamelen
         - unparam
         - gosec
-    - path: celext/lib.go
+    - path: cel/library.go
       linters:
         # setting up custom functions/overloads appears duplicative (false positive)
         - dupl
         # Types are checked internally within CEL. There are bigger issues if its
         # type analysis is wrong
         - forcetypeassert
     # static unexported lookup tables
-    - path: internal/constraints/lookups.go
+    - path: lookups.go
       linters:
         - gochecknoglobals
     - path: resolver/resolver.go

README.md

@@ -182,23 +182,9 @@ validator, err := protovalidate.New(
 )
 ```
 
-### Support legacy `protoc-gen-validate` constraints
+### Legacy `protoc-gen-validate` constraints
 
-The `protovalidate-go` module comes with a `legacy` package which adds opt-in support
-for existing `protoc-gen-validate` constraints. Provide the`legacy.WithLegacySupport`
-option when initializing the validator:
-
-```go
-validator, err := protovalidate.New(
-  legacy.WithLegacySupport(legacy.ModeMerge),
-)
-```
-
-`protoc-gen-validate` code generation is **not** used by `protovalidate-go`. The
-`legacy` package assumes the `protoc-gen-validate` extensions are imported into
-the generated code via `github.com/envoyproxy/protoc-gen-validate/validate`.
-
-A [migration tool](https://github.com/bufbuild/protovalidate/tree/main/tools/protovalidate-migrate) is also available to incrementally upgrade legacy constraints in `.proto` files.
+`protoc-gen-validate` code generation is **not** used by `protovalidate-go`. A [migration tool](https://github.com/bufbuild/protovalidate/tree/main/tools/protovalidate-migrate) is available to upgrade legacy constraints in `.proto` files.
 
 ## Performance
 

internal/evaluator/any.go renamed to any.go

@@ -12,11 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package evaluator
+package protovalidate
 
 import (
 	"buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
-	"github.com/bufbuild/protovalidate-go/internal/errors"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protoreflect"
 )
@@ -27,15 +26,15 @@ var (
 	anyInRuleDescriptor = (&validate.AnyRules{}).ProtoReflect().Descriptor().Fields().ByName("in")
 	anyInRulePath       = &validate.FieldPath{
 		Elements: []*validate.FieldPathElement{
-			errors.FieldPathElement(anyRuleDescriptor),
-			errors.FieldPathElement(anyInRuleDescriptor),
+			fieldPathElement(anyRuleDescriptor),
+			fieldPathElement(anyInRuleDescriptor),
 		},
 	}
 	anyNotInDescriptor = (&validate.AnyRules{}).ProtoReflect().Descriptor().Fields().ByName("not_in")
 	anyNotInRulePath   = &validate.FieldPath{
 		Elements: []*validate.FieldPathElement{
-			errors.FieldPathElement(anyRuleDescriptor),
-			errors.FieldPathElement(anyNotInDescriptor),
+			fieldPathElement(anyRuleDescriptor),
+			fieldPathElement(anyNotInDescriptor),
 		},
 	}
 )
@@ -62,10 +61,10 @@ type anyPB struct {
 func (a anyPB) Evaluate(val protoreflect.Value, failFast bool) error {
 	typeURL := val.Message().Get(a.TypeURLDescriptor).String()
 
-	err := &errors.ValidationError{}
+	err := &ValidationError{}
 	if len(a.In) > 0 {
 		if _, ok := a.In[typeURL]; !ok {
-			err.Violations = append(err.Violations, &errors.Violation{
+			err.Violations = append(err.Violations, &Violation{
 				Proto: &validate.Violation{
 					Field:        a.base.fieldPath(),
 					Rule:         a.base.rulePath(anyInRulePath),
@@ -85,7 +84,7 @@ func (a anyPB) Evaluate(val protoreflect.Value, failFast bool) error {
 
 	if len(a.NotIn) > 0 {
 		if _, ok := a.NotIn[typeURL]; ok {
-			err.Violations = append(err.Violations, &errors.Violation{
+			err.Violations = append(err.Violations, &Violation{
 				Proto: &validate.Violation{
 					Field:        a.base.fieldPath(),
 					Rule:         a.base.rulePath(anyNotInRulePath),

internal/expression/ast.go renamed to ast.go

@@ -12,25 +12,26 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package expression
+package protovalidate
 
 import (
+	"fmt"
+
 	"buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
-	"github.com/bufbuild/protovalidate-go/internal/errors"
 	"github.com/google/cel-go/cel"
 	"github.com/google/cel-go/interpreter"
 	"google.golang.org/protobuf/reflect/protoreflect"
 )
 
-// ASTSet represents a collection of compiledAST and their associated cel.Env.
-type ASTSet struct {
+// astSet represents a collection of compiledAST and their associated cel.Env.
+type astSet struct {
 	env  *cel.Env
 	asts []compiledAST
 }
 
 // Merge combines a set with another, producing a new ASTSet.
-func (set ASTSet) Merge(other ASTSet) ASTSet {
-	out := ASTSet{
+func (set astSet) Merge(other astSet) astSet {
+	out := astSet{
 		env:  set.env,
 		asts: make([]compiledAST, 0, len(set.asts)+len(other.asts)),
 	}
@@ -47,7 +48,7 @@ func (set ASTSet) Merge(other ASTSet) ASTSet {
 // either a true or empty string constant result, no compiledProgram is
 // generated for it. The main usage of this is to elide tautological expressions
 // from the final result.
-func (set ASTSet) ReduceResiduals(opts ...cel.ProgramOption) (ProgramSet, error) {
+func (set astSet) ReduceResiduals(opts ...cel.ProgramOption) (programSet, error) {
 	residuals := make([]compiledAST, 0, len(set.asts))
 	options := append([]cel.ProgramOption{
 		cel.EvalOptions(
@@ -91,18 +92,18 @@ func (set ASTSet) ReduceResiduals(opts ...cel.ProgramOption) (ProgramSet, error)
 		}
 	}
 
-	return ASTSet{
+	return astSet{
 		env:  set.env,
 		asts: residuals,
 	}.ToProgramSet(opts...)
 }
 
 // ToProgramSet generates a ProgramSet from the specified ASTs.
-func (set ASTSet) ToProgramSet(opts ...cel.ProgramOption) (out ProgramSet, err error) {
+func (set astSet) ToProgramSet(opts ...cel.ProgramOption) (out programSet, err error) {
 	if l := len(set.asts); l == 0 {
 		return nil, nil
 	}
-	out = make(ProgramSet, len(set.asts))
+	out = make(programSet, len(set.asts))
 	for i, ast := range set.asts {
 		out[i], err = ast.toProgram(set.env, opts...)
 		if err != nil {
@@ -113,7 +114,7 @@ func (set ASTSet) ToProgramSet(opts ...cel.ProgramOption) (out ProgramSet, err e
 }
 
 // SetRuleValue sets the rule value for the programs in the ASTSet.
-func (set *ASTSet) SetRuleValue(
+func (set *astSet) SetRuleValue(
 	ruleValue protoreflect.Value,
 	ruleDescriptor protoreflect.FieldDescriptor,
 ) {
@@ -135,8 +136,7 @@ type compiledAST struct {
 func (ast compiledAST) toProgram(env *cel.Env, opts ...cel.ProgramOption) (out compiledProgram, err error) {
 	prog, err := env.Program(ast.AST, opts...)
 	if err != nil {
-		return out, errors.NewCompilationErrorf(
-			"failed to compile program %s: %w", ast.Source.GetId(), err)
+		return out, &CompilationError{cause: fmt.Errorf("failed to compile program %s: %w", ast.Source.GetId(), err)}
 	}
 	return compiledProgram{
 		Program:    prog,

internal/expression/ast_test.go renamed to ast_test.go

@@ -12,13 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package expression
+package protovalidate
 
 import (
 	"testing"
 
 	"buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
-	"github.com/bufbuild/protovalidate-go/celext"
+	pvcel "github.com/bufbuild/protovalidate-go/cel"
 	"github.com/google/cel-go/cel"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -28,8 +28,8 @@ import (
 func TestASTSet_Merge(t *testing.T) {
 	t.Parallel()
 
-	var set ASTSet
-	other := ASTSet{
+	var set astSet
+	other := astSet{
 		env: &cel.Env{},
 		asts: []compiledAST{
 			{AST: &cel.Ast{}},
@@ -40,7 +40,7 @@ func TestASTSet_Merge(t *testing.T) {
 	assert.Equal(t, other.env, merged.env)
 	assert.Equal(t, other.asts, merged.asts)
 
-	another := ASTSet{
+	another := astSet{
 		asts: []compiledAST{
 			{AST: &cel.Ast{}},
 			{AST: &cel.Ast{}},
@@ -56,11 +56,11 @@ func TestASTSet_Merge(t *testing.T) {
 func TestASTSet_ToProgramSet(t *testing.T) {
 	t.Parallel()
 
-	env, err := celext.DefaultEnv(false)
+	env, err := cel.NewEnv(cel.Lib(pvcel.NewLibrary()))
 	require.NoError(t, err)
 
-	asts, err := CompileASTs(
-		Expressions{
+	asts, err := compileASTs(
+		expressions{
 			Constraints: []*validate.Constraint{
 				{Expression: proto.String("foo")},
 			},
@@ -75,7 +75,7 @@ func TestASTSet_ToProgramSet(t *testing.T) {
 	assert.Len(t, set, 1)
 	assert.Equal(t, asts.asts[0].Source, set[0].Source)
 
-	empty := ASTSet{}
+	empty := astSet{}
 	set, err = empty.ToProgramSet()
 	assert.Empty(t, set)
 	require.NoError(t, err)
@@ -84,11 +84,11 @@ func TestASTSet_ToProgramSet(t *testing.T) {
 func TestASTSet_ReduceResiduals(t *testing.T) {
 	t.Parallel()
 
-	env, err := celext.DefaultEnv(false)
+	env, err := cel.NewEnv(cel.Lib(pvcel.NewLibrary()))
 	require.NoError(t, err)
 
-	asts, err := CompileASTs(
-		Expressions{
+	asts, err := compileASTs(
+		expressions{
 			Constraints: []*validate.Constraint{
 				{Expression: proto.String("foo")},
 			},
@@ -98,7 +98,7 @@ func TestASTSet_ReduceResiduals(t *testing.T) {
 	)
 	require.NoError(t, err)
 	assert.Len(t, asts.asts, 1)
-	set, err := asts.ReduceResiduals(cel.Globals(&Variable{Name: "foo", Val: true}))
+	set, err := asts.ReduceResiduals(cel.Globals(&variable{Name: "foo", Val: true}))
 	require.NoError(t, err)
 	assert.Empty(t, set)
 }

internal/evaluator/base.go renamed to base.go

@@ -12,11 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package evaluator
+package protovalidate
 
 import (
 	"buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
-	"github.com/bufbuild/protovalidate-go/internal/errors"
 	"google.golang.org/protobuf/reflect/protoreflect"
 )
 
@@ -39,7 +38,7 @@ type base struct {
 func newBase(valEval *value) base {
 	return base{
 		Descriptor:       valEval.Descriptor,
-		FieldPathElement: errors.FieldPathElement(valEval.Descriptor),
+		FieldPathElement: fieldPathElement(valEval.Descriptor),
 		RulePrefix:       valEval.NestedRule,
 	}
 }