refactor: Remove ParsedGoType from codegen.proto, pass in opts as JSON
#2918
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `ParsedGoType` 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. 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. 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.
andrewmbenton
force-pushed
the
andrew/codegen-proto-update
branch
from
585bec5
to
41343ab
Compare
andrewmbenton
commented
Oct 26, 2023
| QuerySetOverrides []Override `json:"overrides,omitempty"` | ||
| QuerySetRename json.RawMessage `json:"rename,omitempty"` // Unused, TODO merge with req.Settings.Rename | ||
|
|
||
| Overrides []GoOverride `json:"-"` |
There was a problem hiding this comment.
We consolidate all overrides here and only use overrides parsed from JSON options and overrides coming in from req.Settings.Overrides within ParseOpts() below to build this slice.
andrewmbenton
commented
Oct 26, 2023
| @@ -59,11 +58,10 @@ func mergeImports(imps ...fileImports) [][]ImportSpec { | |||
| } | |||
|
|
|||
| type importer struct { | |||
| Settings *plugin.Settings | |||
There was a problem hiding this comment.
having all overrides in Options lets us drop this field
andrewmbenton
commented
Oct 26, 2023
andrewmbenton
commented
Oct 26, 2023
Comment on lines
-17
to
-51
| }, | ||
| "go": { | ||
| "emit_interface": false, | ||
| "emit_json_tags": false, | ||
| "emit_db_tags": false, | ||
| "emit_prepared_queries": false, | ||
| "emit_exact_table_names": false, | ||
| "emit_empty_slices": false, | ||
| "emit_exported_queries": false, | ||
| "emit_result_struct_pointers": false, | ||
| "emit_params_struct_pointers": false, | ||
| "emit_methods_with_db_argument": false, | ||
| "json_tags_case_style": "", | ||
| "package": "", | ||
| "out": "", | ||
| "sql_package": "", | ||
| "sql_driver": "", | ||
| "output_db_file_name": "", | ||
| "output_models_file_name": "", | ||
| "output_querier_file_name": "", | ||
| "output_copyfrom_file_name": "", | ||
| "output_files_suffix": "", | ||
| "emit_enum_valid_method": false, | ||
| "emit_all_enum_values": false, | ||
| "inflection_exclude_table_names": [], | ||
| "emit_pointers_for_null_types": false, | ||
| "query_parameter_limit": 1, | ||
| "output_batch_file_name": "", | ||
| "json_tags_id_uppercase": false, | ||
| "omit_unused_structs": false | ||
| }, | ||
| "json": { | ||
| "out": "", | ||
| "indent": "", | ||
| "filename": "" |
There was a problem hiding this comment.
This is cleanup from previous change in #2822
andrewmbenton
changed the title
Overrides from Settings in codegen.proto, pass in JSON optsParsedGoType from codegen.proto, pass in opts as JSON
andrewmbenton
commented
Oct 27, 2023
Comment on lines
+1
to
+2
| # package override | ||
| error generating code: bad syntax for struct tag pair |
There was a problem hiding this comment.
Because struct tags get parsed in the codegen plugin now
kyleconroy
reviewed
Oct 27, 2023
andrewmbenton
force-pushed
the
andrew/codegen-proto-update
branch
from
8691140
to
af4a202
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
ParsedGoTypeconfiguration 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.