encoding/openapi: drop support for Config.ReferenceFunc

It has been deprecated in favor of Config.NameFunc
since https://cuelang.org/cl/542287 in August 2022.

Since it has been two years with the deprecation notice,
and switching from ReferenceFunc to NameFunc with feature parity
is possible, and we want to transition away from cue.Instance,
remove the option and tests entirely.

Note that the tests using ReferenceFunc already have variants
without the deprecated option. We can simplify the tests a bit too
to only use the cue.Value entrypoint now, which gives us equal coverage.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: Ic90024efd7bb771077e1bd6e5862f76de133437e
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1201768
TryBot-Result: CUEcueckoo <[email protected]>
Unity-Result: CUE porcuepine <[email protected]>
Reviewed-by: Roger Peppe <[email protected]>

Author: mvdan

encoding/openapi/build.go

@@ -28,7 +28,6 @@ import (
 	"cuelang.org/go/cue/token"
 	"cuelang.org/go/internal"
 	"cuelang.org/go/internal/core/adt"
-	internalvalue "cuelang.org/go/internal/value"
 )
 
 type buildContext struct {
@@ -77,7 +76,6 @@ type typeFunc func(b *builder, a cue.Value)
 
 func schemas(g *Generator, inst cue.InstanceOrValue) (schemas *ast.StructLit, err error) {
 	val := inst.Value()
-	_, isInstance := inst.(*cue.Instance)
 	var fieldFilter *regexp.Regexp
 	if g.FieldFilter != "" {
 		fieldFilter, err = regexp.Compile(g.FieldFilter)
@@ -111,37 +109,6 @@ func schemas(g *Generator, inst cue.InstanceOrValue) (schemas *ast.StructLit, er
 		externalRefs: map[string]*externalType{},
 		fieldFilter:  fieldFilter,
 	}
-	if g.ReferenceFunc != nil {
-		if !isInstance {
-			panic("cannot use ReferenceFunc along with cue.Value")
-		}
-		if g.NameFunc != nil {
-			panic("cannot specify both ReferenceFunc and NameFunc")
-		}
-
-		c.nameFunc = func(val cue.Value, path cue.Path) string {
-			sels := path.Selectors()
-			labels := make([]string, len(sels))
-			for i, sel := range sels {
-				labels[i] = selectorLabel(sel) // TODO this is arguably incorrect.
-			}
-			inst, ok := c.imports[val]
-			if !ok {
-				r, n := internalvalue.ToInternal(val)
-				buildInst := r.GetInstanceFromNode(n)
-				var err error
-				inst, err = (*cue.Runtime)(r).Build(buildInst)
-				if err != nil {
-					panic("cannot build instance from value")
-				}
-				if c.imports == nil {
-					c.imports = make(map[cue.Value]*cue.Instance)
-				}
-				c.imports[val] = inst
-			}
-			return g.ReferenceFunc(inst, labels)
-		}
-	}
 
 	switch g.Version {
 	case "3.0.0":

encoding/openapi/openapi.go

@@ -36,16 +36,6 @@ type Config struct {
 	// Info may be a *ast.StructLit or any type that marshals to JSON.
 	Info interface{}
 
-	// ReferenceFunc allows users to specify an alternative representation
-	// for references. An empty string tells the generator to expand the type
-	// in place and, if applicable, not generate a schema for that entity.
-	//
-	// If this field is non-nil and a cue.Value is passed as the InstanceOrValue,
-	// there will be a panic.
-	//
-	// Deprecated: use NameFunc instead.
-	ReferenceFunc func(inst *cue.Instance, path []string) string
-
 	// NameFunc allows users to specify an alternative representation
 	// for references. It is called with the value passed to the top level
 	// method or function and the path to the entity being generated.

encoding/openapi/openapi_test.go

@@ -25,7 +25,6 @@ import (
 	"github.com/google/go-cmp/cmp"
 
 	"cuelang.org/go/cue"
-	"cuelang.org/go/cue/build"
 	"cuelang.org/go/cue/cuecontext"
 	"cuelang.org/go/cue/errors"
 	"cuelang.org/go/cue/load"
@@ -42,38 +41,20 @@ func TestParseDefinitions(t *testing.T) {
 	resolveRefs := &openapi.Config{Info: info, ExpandReferences: true}
 
 	testCases := []struct {
-		in, out      string
-		variant      string
-		instanceOnly bool
-		valueOnly    bool
-		config       *openapi.Config
-		err          string
+		in, out string
+		variant string
+		config  *openapi.Config
+		err     string
 	}{{
 		in:     "structural.cue",
 		out:    "structural.json",
 		config: resolveRefs,
 	}, {
-		in:           "structural.cue",
-		variant:      "+ReferenceFunc",
-		out:          "structural.json",
-		instanceOnly: true,
+		in:  "protobuf.cue",
+		out: "protobuf.json",
 		config: &openapi.Config{
 			Info:             info,
 			ExpandReferences: true,
-			ReferenceFunc: func(v *cue.Instance, path []string) string {
-				return strings.Join(path, "_")
-			},
-		},
-	}, {
-		in:           "protobuf.cue",
-		out:          "protobuf.json",
-		instanceOnly: true,
-		config: &openapi.Config{
-			Info:             info,
-			ExpandReferences: true,
-			ReferenceFunc: func(p *cue.Instance, path []string) string {
-				return strings.Join(path, ".")
-			},
 		},
 	}, {
 		in:     "nested.cue",
@@ -160,20 +141,6 @@ func TestParseDefinitions(t *testing.T) {
 				return "Randomly picked description from a set of size one."
 			},
 		},
-	}, {
-		in:           "oneof.cue",
-		out:          "oneof-funcs.json",
-		variant:      "+ReferenceFunc",
-		instanceOnly: true,
-		config: &openapi.Config{
-			Info: info,
-			ReferenceFunc: func(v *cue.Instance, path []string) string {
-				return strings.ToUpper(strings.Join(path, "_"))
-			},
-			DescriptionFunc: func(v cue.Value) string {
-				return "Randomly picked description from a set of size one."
-			},
-		},
 	}, {
 		in:  "refs.cue",
 		out: "refs.json",
@@ -187,21 +154,6 @@ func TestParseDefinitions(t *testing.T) {
 				return strings.TrimPrefix(path.String(), "#")
 			},
 		},
-	}, {
-		in:           "refs.cue",
-		out:          "refs.json",
-		variant:      "+ReferenceFunc",
-		instanceOnly: true,
-		config: &openapi.Config{
-			Info: info,
-			ReferenceFunc: func(v *cue.Instance, path []string) string {
-				switch {
-				case strings.HasPrefix(path[0], "Excluded"):
-					return ""
-				}
-				return strings.Join(path, ".")
-			},
-		},
 	}, {
 		in:     "issue131.cue",
 		out:    "issue131.json",
@@ -268,27 +220,12 @@ func TestParseDefinitions(t *testing.T) {
 			inst := load.Instances([]string{filename}, &load.Config{
 				Dir: "./testdata",
 			})[0]
-			if !tc.valueOnly {
-				t.Run("Instance", func(t *testing.T) {
-					// Old style call, with *cue.Instance.
-					inst := cue.Build([]*build.Instance{inst})[0]
-					if inst.Err != nil {
-						t.Fatal(errors.Details(inst.Err, nil))
-					}
-					run(t, inst)
-				})
-			}
-			if !tc.instanceOnly {
-				t.Run("Value", func(t *testing.T) {
-					// New style call, with cue.Value
-					ctx := cuecontext.New()
-					v := ctx.BuildInstance(inst)
-					if err := v.Err(); err != nil {
-						t.Fatal(errors.Details(err, nil))
-					}
-					run(t, v)
-				})
+			ctx := cuecontext.New()
+			v := ctx.BuildInstance(inst)
+			if err := v.Err(); err != nil {
+				t.Fatal(errors.Details(err, nil))
 			}
+			run(t, v)
 		})
 	}
 }