refactor: Remove Overrides from codegen.proto, pass in opts as JSON

The `Overrides` configuration only applies to Go, so we remove it from the codegen plugin proto and instead pass the configuration as JSON to be unmarshaled by the codegen/golang package like other options. Also pull codegen/golang opts into its own package since its about to get a lot more complex.

Eventually we will need to push all of the validation of overrides from internal/config into the codegen/golang package, but that's a fair bit of work so I didn't push it here.

A lot of the changes in this diff are just from pushing the `opts` type within codegen/golang into a package, which is necessary eventually but pretty distracting right now so sorry about that.

Aside from the proto change, which is obviously important, the other meaningful change is to generate.go on line 421, and the function implementation in shim.go. The types in opts/override.go are just recreations of what the plugin proto types were.

Author: andrewmbenton

internal/cmd/generate.go

@@ -418,7 +418,7 @@ func codegen(ctx context.Context, combo config.CombinedSettings, sql outPair, re
 	case sql.Gen.Go != nil:
 		out = combo.Go.Out
 		handler = ext.HandleFunc(golang.Generate)
-		opts, err := json.Marshal(sql.Gen.Go)
+		opts, err := json.Marshal(pluginGoOpts(sql.Gen.Go, combo, result))
 		if err != nil {
 			return "", nil, fmt.Errorf("opts marshal failed: %w", err)
 		}

internal/cmd/shim.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"strings"
 
+	goopts "github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 	"github.com/sqlc-dev/sqlc/internal/compiler"
 	"github.com/sqlc-dev/sqlc/internal/config"
 	"github.com/sqlc-dev/sqlc/internal/config/convert"
@@ -11,7 +12,7 @@ import (
 	"github.com/sqlc-dev/sqlc/internal/sql/catalog"
 )
 
-func pluginOverride(r *compiler.Result, o config.Override) *plugin.Override {
+func pluginOverride(r *compiler.Result, o config.Override) goopts.Override {
 	var column string
 	var table plugin.Identifier
 
@@ -33,7 +34,7 @@ func pluginOverride(r *compiler.Result, o config.Override) *plugin.Override {
 			column = colParts[3]
 		}
 	}
-	return &plugin.Override{
+	return goopts.Override{
 		CodeType:   "", // FIXME
 		DbType:     o.DBType,
 		Nullable:   o.Nullable,
@@ -46,18 +47,13 @@ func pluginOverride(r *compiler.Result, o config.Override) *plugin.Override {
 }
 
 func pluginSettings(r *compiler.Result, cs config.CombinedSettings) *plugin.Settings {
-	var over []*plugin.Override
-	for _, o := range cs.Overrides {
-		over = append(over, pluginOverride(r, o))
-	}
 	return &plugin.Settings{
-		Version:   cs.Global.Version,
-		Engine:    string(cs.Package.Engine),
-		Schema:    []string(cs.Package.Schema),
-		Queries:   []string(cs.Package.Queries),
-		Overrides: over,
-		Rename:    cs.Rename,
-		Codegen:   pluginCodegen(cs, cs.Codegen),
+		Version: cs.Global.Version,
+		Engine:  string(cs.Package.Engine),
+		Schema:  []string(cs.Package.Schema),
+		Queries: []string(cs.Package.Queries),
+		Rename:  cs.Rename,
+		Codegen: pluginCodegen(cs, cs.Codegen),
 	}
 }
 
@@ -101,12 +97,12 @@ func pluginWASM(p config.Plugin) *plugin.Codegen_WASM {
 	return nil
 }
 
-func pluginGoType(o config.Override) *plugin.ParsedGoType {
+func pluginGoType(o config.Override) *goopts.ParsedGoType {
 	// Note that there is a slight mismatch between this and the
 	// proto api. The GoType on the override is the unparsed type,
 	// which could be a qualified path or an object, as per
 	// https://docs.sqlc.dev/en/v1.18.0/reference/config.html#type-overriding
-	return &plugin.ParsedGoType{
+	return &goopts.ParsedGoType{
 		ImportPath: o.GoImportPath,
 		Package:    o.GoPackage,
 		TypeName:   o.GoTypeName,
@@ -115,6 +111,46 @@ func pluginGoType(o config.Override) *plugin.ParsedGoType {
 	}
 }
 
+func pluginGoOpts(sqlGo *config.SQLGo, cs config.CombinedSettings, r *compiler.Result) *goopts.Options {
+	var overrides []goopts.Override
+	for _, o := range cs.Overrides {
+		overrides = append(overrides, pluginOverride(r, o))
+	}
+	return &goopts.Options{
+		EmitInterface:             sqlGo.EmitInterface,
+		EmitJsonTags:              sqlGo.EmitJSONTags,
+		JsonTagsIdUppercase:       sqlGo.JsonTagsIDUppercase,
+		EmitDbTags:                sqlGo.EmitDBTags,
+		EmitPreparedQueries:       sqlGo.EmitPreparedQueries,
+		EmitExactTableNames:       sqlGo.EmitExactTableNames,
+		EmitEmptySlices:           sqlGo.EmitEmptySlices,
+		EmitExportedQueries:       sqlGo.EmitExportedQueries,
+		EmitResultStructPointers:  sqlGo.EmitResultStructPointers,
+		EmitParamsStructPointers:  sqlGo.EmitParamsStructPointers,
+		EmitMethodsWithDbArgument: sqlGo.EmitMethodsWithDBArgument,
+		EmitPointersForNullTypes:  sqlGo.EmitPointersForNullTypes,
+		EmitEnumValidMethod:       sqlGo.EmitEnumValidMethod,
+		EmitAllEnumValues:         sqlGo.EmitAllEnumValues,
+		JsonTagsCaseStyle:         sqlGo.JSONTagsCaseStyle,
+		Package:                   sqlGo.Package,
+		Out:                       sqlGo.Out,
+		Overrides:                 overrides,
+		// Rename intentionally omitted
+		SqlPackage:                  sqlGo.SQLPackage,
+		SqlDriver:                   sqlGo.SQLDriver,
+		OutputBatchFileName:         sqlGo.OutputBatchFileName,
+		OutputDbFileName:            sqlGo.OutputDBFileName,
+		OutputModelsFileName:        sqlGo.OutputModelsFileName,
+		OutputQuerierFileName:       sqlGo.OutputQuerierFileName,
+		OutputCopyfromFileName:      sqlGo.OutputCopyFromFileName,
+		OutputFilesSuffix:           sqlGo.OutputFilesSuffix,
+		InflectionExcludeTableNames: sqlGo.InflectionExcludeTableNames,
+		QueryParameterLimit:         sqlGo.QueryParameterLimit,
+		OmitUnusedStructs:           sqlGo.OmitUnusedStructs,
+		BuildTags:                   sqlGo.BuildTags,
+	}
+}
+
 func pluginCatalog(c *catalog.Catalog) *plugin.Catalog {
 	var schemas []*plugin.Schema
 	for _, s := range c.Schemas {

internal/codegen/golang/field.go

@@ -6,6 +6,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 	"github.com/sqlc-dev/sqlc/internal/plugin"
 )
 
@@ -40,7 +41,7 @@ func TagsToString(tags map[string]string) string {
 	return strings.Join(tagParts, " ")
 }
 
-func JSONTagName(name string, options *opts) string {
+func JSONTagName(name string, options *opts.Options) string {
 	style := options.JsonTagsCaseStyle
 	idUppercase := options.JsonTagsIdUppercase
 	if style == "" || style == "none" {

internal/codegen/golang/gen.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 	"text/template"
 
+	"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 	"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
 	"github.com/sqlc-dev/sqlc/internal/metadata"
 	"github.com/sqlc-dev/sqlc/internal/plugin"
@@ -103,12 +104,12 @@ func (t *tmplCtx) codegenQueryRetval(q Query) (string, error) {
 }
 
 func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error) {
-	options, err := parseOpts(req)
+	options, err := opts.ParseOpts(req)
 	if err != nil {
 		return nil, err
 	}
 
-	if err := validateOpts(options); err != nil {
+	if err := opts.ValidateOpts(options); err != nil {
 		return nil, err
 	}
 
@@ -126,7 +127,7 @@ func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenR
 	return generate(req, options, enums, structs, queries)
 }
 
-func generate(req *plugin.CodeGenRequest, options *opts, enums []Enum, structs []Struct, queries []Query) (*plugin.CodeGenResponse, error) {
+func generate(req *plugin.CodeGenRequest, options *opts.Options, enums []Enum, structs []Struct, queries []Query) (*plugin.CodeGenResponse, error) {
 	i := &importer{
 		Settings: req.Settings,
 		Options:  options,

internal/codegen/golang/go_type.go

@@ -3,16 +3,17 @@ package golang
 import (
 	"strings"
 
+	"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 	"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
 	"github.com/sqlc-dev/sqlc/internal/plugin"
 )
 
-func addExtraGoStructTags(tags map[string]string, req *plugin.CodeGenRequest, col *plugin.Column) {
-	for _, oride := range req.Settings.Overrides {
+func addExtraGoStructTags(tags map[string]string, req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) {
+	for _, oride := range options.Overrides {
 		if oride.GoType.StructTags == nil {
 			continue
 		}
-		if !sdk.Matches(oride, col.Table, req.Catalog.DefaultSchema) {
+		if !oride.Matches(col.Table, req.Catalog.DefaultSchema) {
 			// Different table.
 			continue
 		}
@@ -31,17 +32,17 @@ func addExtraGoStructTags(tags map[string]string, req *plugin.CodeGenRequest, co
 	}
 }
 
-func goType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) string {
+func goType(req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) string {
 	// Check if the column's type has been overridden
-	for _, oride := range req.Settings.Overrides {
+	for _, oride := range options.Overrides {
 		if oride.GoType.TypeName == "" {
 			continue
 		}
 		cname := col.Name
 		if col.OriginalName != "" {
 			cname = col.OriginalName
 		}
-		sameTable := sdk.Matches(oride, col.Table, req.Catalog.DefaultSchema)
+		sameTable := oride.Matches(col.Table, req.Catalog.DefaultSchema)
 		if oride.Column != "" && sdk.MatchString(oride.ColumnName, cname) && sameTable {
 			if col.IsSqlcSlice {
 				return "[]" + oride.GoType.TypeName
@@ -59,12 +60,12 @@ func goType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) strin
 	return typ
 }
 
-func goInnerType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) string {
+func goInnerType(req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) string {
 	columnType := sdk.DataType(col.Type)
 	notNull := col.NotNull || col.IsArray
 
 	// package overrides have a higher precedence
-	for _, oride := range req.Settings.Overrides {
+	for _, oride := range options.Overrides {
 		if oride.GoType.TypeName == "" {
 			continue
 		}

internal/codegen/golang/imports.go

@@ -5,6 +5,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 	"github.com/sqlc-dev/sqlc/internal/metadata"
 	"github.com/sqlc-dev/sqlc/internal/plugin"
 )
@@ -59,7 +60,7 @@ func mergeImports(imps ...fileImports) [][]ImportSpec {
 
 type importer struct {
 	Settings *plugin.Settings
-	Options  *opts
+	Options  *opts.Options
 	Queries  []Query
 	Enums    []Enum
 	Structs  []Struct
@@ -156,7 +157,7 @@ var pqtypeTypes = map[string]struct{}{
 	"pqtype.NullRawMessage": {},
 }
 
-func buildImports(settings *plugin.Settings, options *opts, queries []Query, uses func(string) bool) (map[string]struct{}, map[ImportSpec]struct{}) {
+func buildImports(options *opts.Options, queries []Query, uses func(string) bool) (map[string]struct{}, map[ImportSpec]struct{}) {
 	pkg := make(map[ImportSpec]struct{})
 	std := make(map[string]struct{})
 
@@ -200,7 +201,7 @@ func buildImports(settings *plugin.Settings, options *opts, queries []Query, use
 	}
 
 	overrideTypes := map[string]string{}
-	for _, o := range settings.Overrides {
+	for _, o := range options.Overrides {
 		if o.GoType.BasicType || o.GoType.TypeName == "" {
 			continue
 		}
@@ -225,7 +226,7 @@ func buildImports(settings *plugin.Settings, options *opts, queries []Query, use
 	}
 
 	// Custom imports
-	for _, o := range settings.Overrides {
+	for _, o := range options.Overrides {
 		if o.GoType.BasicType || o.GoType.TypeName == "" {
 			continue
 		}
@@ -240,7 +241,7 @@ func buildImports(settings *plugin.Settings, options *opts, queries []Query, use
 }
 
 func (i *importer) interfaceImports() fileImports {
-	std, pkg := buildImports(i.Settings, i.Options, i.Queries, func(name string) bool {
+	std, pkg := buildImports(i.Options, i.Queries, func(name string) bool {
 		for _, q := range i.Queries {
 			if q.hasRetType() {
 				if usesBatch([]Query{q}) {
@@ -265,7 +266,7 @@ func (i *importer) interfaceImports() fileImports {
 }
 
 func (i *importer) modelImports() fileImports {
-	std, pkg := buildImports(i.Settings, i.Options, nil, i.usesType)
+	std, pkg := buildImports(i.Options, nil, i.usesType)
 
 	if len(i.Enums) > 0 {
 		std["fmt"] = struct{}{}
@@ -304,7 +305,7 @@ func (i *importer) queryImports(filename string) fileImports {
 		}
 	}
 
-	std, pkg := buildImports(i.Settings, i.Options, gq, func(name string) bool {
+	std, pkg := buildImports(i.Options, gq, func(name string) bool {
 		for _, q := range gq {
 			if q.hasRetType() {
 				if q.Ret.EmitStruct() {
@@ -405,7 +406,7 @@ func (i *importer) copyfromImports() fileImports {
 			copyFromQueries = append(copyFromQueries, q)
 		}
 	}
-	std, pkg := buildImports(i.Settings, i.Options, copyFromQueries, func(name string) bool {
+	std, pkg := buildImports(i.Options, copyFromQueries, func(name string) bool {
 		for _, q := range copyFromQueries {
 			if q.hasRetType() {
 				if strings.HasPrefix(q.Ret.Type(), name) {
@@ -440,7 +441,7 @@ func (i *importer) batchImports() fileImports {
 			batchQueries = append(batchQueries, q)
 		}
 	}
-	std, pkg := buildImports(i.Settings, i.Options, batchQueries, func(name string) bool {
+	std, pkg := buildImports(i.Options, batchQueries, func(name string) bool {
 		for _, q := range batchQueries {
 			if q.hasRetType() {
 				if q.Ret.EmitStruct() {