chore: minor option naming refactor (#1660)

This PR renames two of the member fields of the option struct more
descriptive names.

Author: shollyman

internal/gengapic/custom_operation.go

@@ -33,7 +33,7 @@ type customOp struct {
 
 // isCustomOp determines if the given method should return a custom operation wrapper.
 func (g *generator) isCustomOp(m *descriptorpb.MethodDescriptorProto, info *httpInfo) bool {
-	return g.opts.diregapic && // Generator in DIREGAPIC mode.
+	return g.opts.generateAsDIREGAPIC && // Generator in DIREGAPIC mode.
 		g.aux.customOp != nil && // API Defines a custom operation.
 		m.GetOutputType() == g.customOpProtoName() && // Method returns the custom operation.
 		m.GetName() != "Wait" && // Method is not a Wait (uses POST).

internal/gengapic/example_test.go

@@ -246,9 +246,9 @@ func TestExample(t *testing.T) {
 		{
 			tstName: "custom_op_example",
 			options: options{
-				pkgName:    "Bar",
-				transports: []transport{rest},
-				diregapic:  true,
+				pkgName:             "Bar",
+				transports:          []transport{rest},
+				generateAsDIREGAPIC: true,
 			},
 			imports: map[pbinfo.ImportSpec]bool{
 				{Path: "context"}:                        true,
@@ -263,7 +263,7 @@ func TestExample(t *testing.T) {
 			g.reset()
 			g.opts = &tst.options
 			g.mixins = mix
-			if tst.options.diregapic {
+			if tst.options.generateAsDIREGAPIC {
 				g.mixins = nil
 			}
 			g.aux.customOp = tst.op
@@ -281,7 +281,7 @@ func TestExample(t *testing.T) {
 
 			g.opts = &tst.options
 			g.mixins = mix
-			if tst.options.diregapic {
+			if tst.options.generateAsDIREGAPIC {
 				g.mixins = nil
 			}
 			g.aux.customOp = tst.op

internal/gengapic/gengapic.go

@@ -85,7 +85,7 @@ func gen(genReq *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse
 
 	protoPkg := g.descInfo.ParentFile[genServs[0]].GetPackage()
 
-	if op, ok := g.descInfo.Type[fmt.Sprintf(".%s.Operation", protoPkg)]; g.opts.diregapic && ok {
+	if op, ok := g.descInfo.Type[fmt.Sprintf(".%s.Operation", protoPkg)]; g.opts.generateAsDIREGAPIC && ok {
 		g.aux.customOp = &customOp{
 			message:       op.(*descriptorpb.DescriptorProto),
 			handles:       []*descriptorpb.ServiceDescriptorProto{},
@@ -164,7 +164,7 @@ func gen(genReq *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse
 		Content: proto.String(g.pt.String()),
 	})
 
-	if g.opts.metadata {
+	if g.opts.generateGAPICMetadata {
 		g.reset()
 		g.genGapicMetadataFile()
 		g.resp.File = append(g.resp.File, &pluginpb.CodeGeneratorResponse_File{

internal/gengapic/gengapic_test.go

@@ -1234,7 +1234,7 @@ func TestReturnType(t *testing.T) {
 			},
 		},
 		opts: &options{
-			diregapic: true,
+			generateAsDIREGAPIC: true,
 		},
 		descInfo: pbinfo.Info{
 			ParentFile: map[protoreflect.ProtoMessage]*descriptorpb.FileDescriptorProto{

internal/gengapic/genrest.go

@@ -1189,7 +1189,7 @@ func (g *generator) protoJSONMarshaler() {
 	// enum. However, since they are synthetic protos, the enum numbers likely
 	// do not match the internal proto enum value, so we do not want to send
 	// any enums as numbers with DIREGAPIC clients.
-	if g.opts.diregapic {
+	if g.opts.generateAsDIREGAPIC {
 		marshalOpts = "AllowPartial: true"
 	}
 	g.pt.Printf("m := protojson.MarshalOptions{%s}", marshalOpts)

internal/gengapic/genrest_test.go

@@ -753,7 +753,7 @@ func TestGenRestMethod(t *testing.T) {
 		{
 			name:    "custom_op",
 			method:  opRPC,
-			options: &options{diregapic: true},
+			options: &options{generateAsDIREGAPIC: true},
 			imports: map[pbinfo.ImportSpec]bool{
 				{Path: "google.golang.org/protobuf/encoding/protojson"}: true,
 				{Path: "net/url"}: true,

internal/gengapic/options.go

@@ -42,7 +42,7 @@ var DeprecatedArgs map[string]error = map[string]error{
 
 // SupportedBooleanArgs expose boolean plugin arguments (presence enables option).
 var SupportedBooleanArgs map[string]func() configOption = map[string]func() configOption{
-	"metadata":           enableGAPICMetadata,
+	"metadata":           generateGAPICMetadata,
 	"diregapic":          generateAsDIREGAPIC,
 	"rest-numeric-enums": enableRESTNumericEnums,
 	"omit-snippets":      enableOmitSnippets,
@@ -82,12 +82,12 @@ type options struct {
 	outDir string
 
 	// Should GAPIC metadata be generated
-	// TODO: rename this in a subsequent refactor
-	metadata bool
+	generateGAPICMetadata bool
 
-	// Are the input artifacts from a DIREGAPIC source
-	// TODO: rename this in a subsequent refactor
-	diregapic bool
+	// Should the generator respect DIREGAPIC limitations
+	// If the input artifacts are synthetic (e.g. compiled from another IDL source such as a discovery document) then
+	// some protobuf-behaviors should not be relied upon.
+	generateAsDIREGAPIC bool
 
 	// Should the generator code generator numeric enums for REST calls
 	// TODO: rename this in a subsquent refactor
@@ -209,7 +209,7 @@ func validateAndNormalizeOptions(cfg *options) error {
 	}
 
 	// REST enums are not supported by DIREGAPIC.
-	if cfg.diregapic && cfg.restNumericEnum {
+	if cfg.generateAsDIREGAPIC && cfg.restNumericEnum {
 		return errors.New("incompatible features: diregapic and rest numeric enums")
 	}
 
@@ -249,10 +249,10 @@ func withGoGAPICPackage(s string) configOption {
 	}
 }
 
-// enableGAPICMetadata enables generation of GAPIC metadata.
-func enableGAPICMetadata() configOption {
+// generateGAPICMetadata enables generation of GAPIC metadata.
+func generateGAPICMetadata() configOption {
 	return func(cfg *options) error {
-		cfg.metadata = true
+		cfg.generateGAPICMetadata = true
 		return nil
 	}
 }
@@ -263,7 +263,7 @@ func enableGAPICMetadata() configOption {
 // protos (e.g. compute).
 func generateAsDIREGAPIC() configOption {
 	return func(cfg *options) error {
-		cfg.diregapic = true
+		cfg.generateAsDIREGAPIC = true
 		return nil
 	}
 }

internal/gengapic/options_test.go

@@ -59,11 +59,11 @@ func TestParseOptions(t *testing.T) {
 		{
 			param: "metadata,go-gapic-package=path;pkg",
 			expectedOpts: &options{
-				transports: []transport{grpc},
-				pkgPath:    "path",
-				pkgName:    "pkg",
-				outDir:     "path",
-				metadata:   true,
+				transports:            []transport{grpc},
+				pkgPath:               "path",
+				pkgName:               "pkg",
+				outDir:                "path",
+				generateGAPICMetadata: true,
 			},
 		},
 		{
@@ -189,11 +189,11 @@ func TestValidateAndNormalizeOptions(t *testing.T) {
 		{
 			description: "conflict diregapic enum",
 			in: &options{
-				pkgPath:         "path",
-				pkgName:         "name",
-				outDir:          "dir",
-				diregapic:       true,
-				restNumericEnum: true,
+				pkgPath:             "path",
+				pkgName:             "name",
+				outDir:              "dir",
+				generateAsDIREGAPIC: true,
+				restNumericEnum:     true,
 			},
 			wantErr: true,
 		},