[Go-server] - Support for Enums in the Path and Query by icubbon · Pull Request #16781 · OpenAPITools/openapi-generator

icubbon · 2023-10-10T20:14:38Z

Add cases to the api-controller.mustache template for Enums when in the Query and in the Path. Includes required and not required cases, as well as a list of Enums for the Query.
Add logic to the Go-Server Enum Model to have a "constructor" that validates the input. This logic is duplicated from the Go Client Enum Model.

Add examples to the Go-Server test petstore.yaml for an Enum in the Path, optional enum, and required enums.

Small modification needed to the GoServerCodegen.java file to add the necessary fmt import when the model is an enum. This import is needed so that the "Constructor" can return an error.

fixes #11173

There will be conflicts that need to be resolved with #16749 as both are touching the api-controller.mustache file in similar locations.

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh
```
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@lwj5 @wing328

Supports optional Query Enums and Lists of Enums as well Add an example endpoint that covers the added scenarios Added an import mapping for the GoServerCodegen for "fmt" when a model is an enum. Expanded the Enum Model for the Go Server to have validation. Copied this logic from the Go Client Enum Model.

lwj5

Minor performance issues

lwj5 · 2023-10-11T00:24:53Z

modules/openapi-generator/src/main/resources/go-server/model.mustache

+)
+
+// All allowed values of {{{classname}}} enum
+var Allowed{{{classname}}}EnumValues = []{{{classname}}}{


Could we do a

map[{{classname}}]struct{}

That should work in O(1) time

Let me know if you need clarifications about this

Allowed{{{classname}}}EnumValues := map[myEnum]struct{}{ "a": {}, "b": {}, }

I changed it to be a map. I had to add in a call to the golang maps package for the error message when an invalid Enum was provided.

lwj5 · 2023-10-11T00:37:35Z

modules/openapi-generator/src/main/resources/go-server/controller-api.mustache

+	{{#items.isEnumRef}}
+	var {{paramName}}Param []{{items.dataType}}
+	if query.Has("{{baseName}}") {
+		for _, param := range strings.Split(query.Get("{{baseName}}"), ",") {


Could we do strings.Split(query.Get("{{baseName}}"), ",") first then create var {{paramName}}Param with the exact size. make([]{{items.dataType}}, size)

lwj5 · 2023-10-11T00:44:23Z

modules/openapi-generator/src/main/resources/go-server/model.mustache

+
+// New{{{classname}}}FromValue returns a pointer to a valid {{{classname}}}
+// for the value passed as argument, or an error if the value passed is not allowed by the enum
+func New{{{classname}}}FromValue(v {{{format}}}{{^format}}{{dataType}}{{/format}}) (*{{{classname}}}, error) {


Could you help me understand why does this function need to return a pointer?

Could you just return a {{{classname}}}

This is the same implementation from the Go-Client Enum mustache template. By using the same implementation, a user can decide to use either the Client's models or the Server's models with only a couple minor problems to jump over.

If we want to change the signatures/implementation of the Go-Server Enum, I would also like to make the same changes to the Go-Client Enum Mustache Template.

You don't need to modify the client as this doesn't affect the interaction between the client and server.

The changes only affect the server code internally. In this case,

you are always dereferencing the return value in the controller (you always want the value)

the pointer is only returned during an err, which means that the pointer will ultimately be discarded

It only makes sense to change the return type to a value since the pointer is redundant.

I made the change to not return a pointer from New{{classname}}FromValue.

the correct size.

…nerator into go-server/enumSupport

lwj5 · 2023-10-13T09:18:39Z

modules/openapi-generator/src/main/resources/go-server/model.mustache

+)
+
+// All allowed values of {{{classname}}} enum
+var Allowed{{{classname}}}EnumValues = map[{{{classname}}}][]struct{}{


Suggested change

var Allowed{{{classname}}}EnumValues = map[{{{classname}}}][]struct{}{

var Allowed{{{classname}}}EnumValues = map[{{{classname}}}]struct{}{

no need extra []

lwj5 · 2023-10-13T09:25:39Z

samples/server/petstore/go-chi-server/go/model_gender.go

+	if ev.IsValid() {
+		return ev, nil
+	} else {
+		return "", fmt.Errorf("invalid value '%v' for Gender: valid values are %v", v, maps.Keys(AllowedGenderEnumValues))


could we store maps.Keys(AllowedGenderEnumValues) as a package var?

I'll do a privately scoped map to do validation checks on inputs and a publicly scoped slice of the enums. The map doesn't seem to be useful from a public usage of the model but the slice of valid enums did get used in my companies code base.

lwj5 · 2023-10-13T09:34:43Z

modules/openapi-generator/src/main/resources/go-server/controller-api.mustache

 	{{#defaultValue}}
-	{{paramName}}Param := "{{defaultValue}}"
 	if query.Has("{{baseName}}") {
-		{{paramName}}Param = query.Get("{{baseName}}")
+		{{paramName}}Param := {{^isString}}{{dataType}}( {{/isString}}query.Get("{{baseName}}"){{^isString}} ){{/isString}}
 	}


Is this an intended change?

seems like no one can now read from {{paramName}}Param since it is declared in the if block scope

Also the default value is removed

Definitely not intended, great catch, thank you so much

lwj5 · 2023-10-13T09:40:20Z

modules/openapi-generator/src/main/resources/go-server/controller-api.mustache

+		param := query.Get("{{baseName}}")
+		{{paramName}}Param = &param


Suggested change

param := query.Get("{{baseName}}")

{{paramName}}Param = &param

{{paramName}}Param = query.Get("{{baseName}}")

lwj5 · 2023-10-13T09:50:28Z

otherwise, it looks ok

lwj5

Lgtm. @wing328 please help to merge

icubbon added 2 commits October 10, 2023 12:41

Fix identation of examples

f7dba37

lwj5 reviewed Oct 11, 2023

View reviewed changes

icubbon and others added 7 commits October 11, 2023 09:54

Pre-allocate the capacity of the slice of Enums to be

fa6b244

the correct size.

Formatting and updated examples

19a370a

Empty-Commit

4afc0be

Switch to using a map to store the valid enum values

7bb5014

Merge branch 'go-server/enumSupport' of github.com:icubbon/openapi-ge…

55d6a8d

…nerator into go-server/enumSupport

Fixed pointer derefs missed from previous change in PR

5a616b0

More fixing of pointer to not pointer

9c23dc4

lwj5 reviewed Oct 13, 2023

View reviewed changes

lwj5 suggested changes Oct 13, 2023

View reviewed changes

Create a map for validation and a list of enums for messaging

fb1652c

lwj5 approved these changes Oct 17, 2023

View reviewed changes

wing328 added Enhancement: Feature Feature: Enum Server: Go labels Oct 17, 2023

wing328 added this to the 7.1.0 milestone Oct 17, 2023

wing328 merged commit 1dd9590 into OpenAPITools:master Oct 17, 2023

icubbon mentioned this pull request Oct 19, 2023

Bugfix of #11173: go-server get param typecasting if variable enum of string #11174

Closed

5 tasks

	var Allowed{{{classname}}}EnumValues = map[{{{classname}}}][]struct{}{
	var Allowed{{{classname}}}EnumValues = map[{{{classname}}}]struct{}{

		param := query.Get("{{baseName}}")
		{{paramName}}Param = &param

	param := query.Get("{{baseName}}")
	{{paramName}}Param = &param
	{{paramName}}Param = query.Get("{{baseName}}")

Uh oh!

Conversation

icubbon commented Oct 10, 2023

PR checklist

Uh oh!

lwj5 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 Oct 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 Oct 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 Oct 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 Oct 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 Oct 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lwj5 commented Oct 13, 2023

Uh oh!

lwj5 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lwj5 left a comment •

edited

Loading

lwj5 Oct 12, 2023 •

edited

Loading

lwj5 Oct 11, 2023 •

edited

Loading

lwj5 Oct 12, 2023 •

edited

Loading

lwj5 Oct 13, 2023 •

edited

Loading

lwj5 Oct 13, 2023 •

edited

Loading