[go-server] Add ability to handle nullable query param #17051

lwj5 · 2023-11-13T10:40:20Z

Add the ability to handle nullable query param

nullable query params will now be passed as a pointer to the servicer.
non-nullable query params will still be passed as value.

There is no breaking changes in this PR

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
```
(For Windows users, please run the script in Git BASH)
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*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
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.

# Conflicts: # samples/openapi3/server/petstore/go/go-petstore/.openapi-generator/VERSION # samples/server/petstore/go-api-server/.openapi-generator/VERSION # samples/server/petstore/go-chi-server/.openapi-generator/VERSION

icubbon · 2023-11-13T15:49:40Z

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

@@ -23,7 +23,7 @@ func New{{classname}}Service() {{classname}}Servicer {
 {{#isDeprecated}}
 // Deprecated
 {{/isDeprecated}}
-func (s *{{classname}}Service) {{nickname}}(ctx context.Context{{#allParams}}, {{paramName}} {{dataType}}{{/allParams}}) (ImplResponse, error) {
+func (s *{{classname}}Service) {{nickname}}(ctx context.Context{{#allParams}}, {{paramName}} {{#isNullable}}*{{/isNullable}}{{dataType}}{{/allParams}}) (ImplResponse, error) {


I don't think isNullable is behaving as you expect it to here. The Pet Store Specs have many non-required params that would show this change but none of them are showing up in this diff.

could you provide a specific example? are they marked as nullable?

One specific example from openapi-generator/samples/server/petstore/go-api-server/api/openapi.yaml is the booleanTest query parameter in deleteUser.

- description: boolean query parameter explode: true in: query name: boolean_test required: false schema: type: boolean style: form

This should result in the the function signature for deleteUser having a *bool parameter for the function signature in openapi-generator/samples/server/petstore/go-api-server/go/api_user_service.go

There are numerous query parameters in that example file that have optional query parameters.

object is not nullable, please see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object

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

lwj5 · 2023-11-16T16:15:36Z

To fix other import issues with os workaround in the future. ref: #11097

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoServerCodegen.java

icubbon · 2023-11-16T16:14:33Z

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

@@ -23,7 +23,7 @@ func New{{classname}}Service() {{classname}}Servicer {
 {{#isDeprecated}}
 // Deprecated
 {{/isDeprecated}}
-func (s *{{classname}}Service) {{nickname}}(ctx context.Context{{#allParams}}, {{paramName}} {{dataType}}{{/allParams}}) (ImplResponse, error) {
+func (s *{{classname}}Service) {{nickname}}(ctx context.Context{{#allParams}}, {{paramName}} {{#isNullable}}*{{/isNullable}}{{dataType}}{{/allParams}}) (ImplResponse, error) {


One specific example from openapi-generator/samples/server/petstore/go-api-server/api/openapi.yaml is the booleanTest query parameter in deleteUser.

- description: boolean query parameter explode: true in: query name: boolean_test required: false schema: type: boolean style: form

This should result in the the function signature for deleteUser having a *bool parameter for the function signature in openapi-generator/samples/server/petstore/go-api-server/go/api_user_service.go

There are numerous query parameters in that example file that have optional query parameters.

lwj5 · 2023-11-16T16:20:01Z

Please be patient, I'm still fixing test issues. I'll request for a review via the "re-request review" button

icubbon · 2023-11-17T18:04:58Z

I'm still researching and reading about how nullable is handled in other generators.

What is currently giving me hesitation is comparing this implementation to how the go-client handles non-required parameters. Below is how the go-client determines if a parameter will be a pointer or a value:
{{name}} {{^required}}{{^isNullable}}{{^isArray}}{{^isFreeFormObject}}*{{/isFreeFormObject}}{{/isArray}}{{/isNullable}}{{/required}}{{{dataType}}} json:"{{{baseName}}}{{^required}},omitempty{{/required}}"{{#withXml}} xml:"{{{baseName}}}{{#isXmlAttribute}},attr{{/isXmlAttribute}}"{{/withXml}}{{#vendorExtensions.x-go-custom-tag}} {{{.}}}{{/vendorExtensions.x-go-custom-tag}}
This specific line is from modules/openapi-generator/src/main/resources/go/model_simple.mustache

icubbon

Examples should be added/edited to cover the new variations of nullable bools, nullable enums, nullable numbers, etc.

icubbon · 2023-11-17T15:32:19Z

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

+	} else {
+		{{#required}}
+		c.errorHandler(w, r, &RequiredError{Field: "{{baseName}}"}, nil)
+		return
+		{{/required}}
+		{{^required}}
+		{{#defaultValue}}
+		param := {{^isString}}{{dataType}}({{/isString}}{{defaultValue}}{{^isString}}){{/isString}}
+		{{paramName}}Param = {{#isNullable}}&{{/isNullable}}param
+		{{/defaultValue}}
+		{{/required}}


I'm not a fan of having empty else clauses in code. If a parameter isn't required and doesn't have a default value, this case will create an empty else clause.

I understand that you are not a fan of empty else block, but is purely cosmetic and does not affect the compiled code and logic. Feel free to suggest fixes or create a PR to update it

icubbon · 2023-11-17T18:08:08Z

samples/openapi3/server/petstore/go/go-petstore/go/api_pet.go

+	{
+		param, err := ReadFormFileToTempFile(r, "file")
+		if err != nil {
+			c.errorHandler(w, r, &ParsingError{Err: err}, nil)
+			return
+		}
+
+		fileParam = param
 	}


This block of code is odd as it is using { to just scope a variable. I have not been of fan of these as they are not common practice and are typically used in a "clever" way to solve a problem.
I know it's a supported feature of the Go language, but it is typically abused in my experience.

I understand that this is uncommon, but this is purely cosmetic and does not affect the semantics of the code.

This will need to be fixed with the larger problem as stated above #17051 (comment)

* fix null request body NPE * fix typo

…ols#17057) * Remove checks for jackson and jsonb from okhttp-gson templates * regenerate samples

* retain deprecated in allof schema handling * add test

* added handling for boolean content type * adapted addition to newer version of template * [python] updated samples

* Update base image of Dockerfile * Make github workflow "Docker tests" manually triggerable * Don't possibly downgrade TLS version * Update Dockerimage in ``run-in-docker.sh`` * Use Maven's non interactive mode inside workflow * Don't spam log * Use java 17 because it won't compile with 21 * Removed hard memory limit as memory should be controlled by the container * Update hub dockerfiles

…Tools#16918) * add socks5 proxy support (requires additional import) * updated examples * build samples. updated to support pydantic python option * rename sock to socks for correct protocol name * add proxy headers for pydantic * fixed param changes from conflict resolution

For model classes with model_something fields, pydantic raises a warning by default: `Field "model_something" has conflict with protected namespace "model_".`. These warnings make no sense here, because most users of the generator have established APIs that they cannot change to conform to pydantic's safety rules. Pydantic will raise an error if we ever conflict with a current attribute like `model_dump`.

* [typescript-axios] Upgrade to axios@^1 * Try fixing tests

* added .net8 * change .net version in the github action * upgrade manual sample

…APITools#17077) * Add passgenau digital logo * Add passgenau digital to users * Add wemakeai logo * Add we-make.ai to users

* refactor: Clean up _response_types_map formatting It matches black's behavior of having trailing commas now. * test: Add test to reproduce OpenAPITools#16967 * fix: deserialize responses even if no returnType Closes OpenAPITools#16967 * refactor: Simplify ApiException subclasses * refactor: Move exception subtype choice to ApiException * feat: Deserialize error responses and add to exceptions * test: Add for error responses with model

@ignore

* add bearer auth API to echo-api * run generate-samples.sh * add resttemplate echo-api sample * add bearer auth test * remove @ignore

* use jdk17 images in Dockerfile * use amazoncorretto:17.0.8-alpine3.18

lwj5 · 2023-12-05T14:27:36Z

Moving to another PR due to bad merge #17321

lwj5 added 2 commits November 13, 2023 18:39

Add nullable to query param

e066b8b

Add nullable to query param

363b330

lwj5 changed the title ~~Add ability to handle null queries~~ [go-server] Add ability to handle null queries Nov 13, 2023

lwj5 changed the title ~~[go-server] Add ability to handle null queries~~ [go-server] Add ability to handle nullable query param Nov 13, 2023

lwj5 added 2 commits November 13, 2023 19:31

Merge branch 'master' into querynull

432d7ba

# Conflicts: # samples/openapi3/server/petstore/go/go-petstore/.openapi-generator/VERSION # samples/server/petstore/go-api-server/.openapi-generator/VERSION # samples/server/petstore/go-chi-server/.openapi-generator/VERSION

Fix generation

607766d

lwj5 force-pushed the querynull branch from 16ed280 to 607766d Compare November 13, 2023 11:34

Fix generation

e62a559

icubbon reviewed Nov 13, 2023

View reviewed changes

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

icubbon reviewed Nov 16, 2023

View reviewed changes

lwj5 requested a review from icubbon November 17, 2023 03:00

icubbon reviewed Nov 17, 2023

View reviewed changes

lwj5 force-pushed the querynull branch from 19c806e to 8bd1c17 Compare December 5, 2023 14:13

lwj5 requested a review from jimschubert as a code owner December 5, 2023 14:13

wing328 and others added 12 commits December 5, 2023 22:14

update lombok dep to newer version (OpenAPITools#17053)

0387d4e

Fix NPE in request body (OpenAPITools#17055)

ea7fc16

* fix null request body NPE * fix typo

[Java][okhttp-gson] remove unreachable code from templates (OpenAPITo…

b3fc40f

…ols#17057) * Remove checks for jackson and jsonb from okhttp-gson templates * regenerate samples

Retain deprecated in allOf schema handling (OpenAPITools#17056)

a9102b8

* retain deprecated in allof schema handling * add test

disabled GetHashCode generation (OpenAPITools#17039)

cdc9a5d

[python] added handling for boolean content type (OpenAPITools#17020)

f13553b

* added handling for boolean content type * adapted addition to newer version of template * [python] updated samples

update algoria settings (OpenAPITools#17064)

3070e32

[typescript-axios] Upgrade to axios@^1 (OpenAPITools#14518)

3f7c9d2

* [typescript-axios] Upgrade to axios@^1 * Try fixing tests

[csharp] Added .net8 (OpenAPITools#17075)

6744004

* added .net8 * change .net version in the github action * upgrade manual sample

jonasheschl and others added 8 commits December 5, 2023 22:14

Add passgenau-digital and we-make.ai as OpenAPI Generator users (Open…

8a52e22

…APITools#17077) * Add passgenau digital logo * Add passgenau digital to users * Add wemakeai logo * Add we-make.ai to users

[Java][resttemplate] Add test for bearer auth (OpenAPITools#17081)

29ea180

* add bearer auth API to echo-api * run generate-samples.sh * add resttemplate echo-api sample * add bearer auth test * remove @ignore

update samples

0c3a0a3

Use JDK17 images in Dockerfile (OpenAPITools#17076)

54f064b

* use jdk17 images in Dockerfile * use amazoncorretto:17.0.8-alpine3.18

Update to include enum and time

3a137d9

fix import

42f151e

Regen

6fa4b16

lwj5 force-pushed the querynull branch from 8bd1c17 to 6fa4b16 Compare December 5, 2023 14:19

lwj5 closed this Dec 5, 2023

lwj5 mentioned this pull request Jul 16, 2024

[GoServer] Generate non-required parameters as pointers (nil-able) #19149

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[go-server] Add ability to handle nullable query param #17051

[go-server] Add ability to handle nullable query param #17051

lwj5 commented Nov 13, 2023 •

edited

Loading

icubbon Nov 13, 2023 •

edited

Loading

lwj5 Nov 16, 2023

icubbon Nov 16, 2023

lwj5 Nov 16, 2023

lwj5 commented Nov 16, 2023

icubbon Nov 16, 2023

lwj5 commented Nov 16, 2023 •

edited

Loading

icubbon commented Nov 17, 2023

icubbon left a comment

icubbon Nov 17, 2023

lwj5 Dec 5, 2023 •

edited

Loading

icubbon Nov 17, 2023

lwj5 Dec 5, 2023 •

edited

Loading

lwj5 commented Dec 5, 2023 •

edited

Loading

[go-server] Add ability to handle nullable query param #17051

[go-server] Add ability to handle nullable query param #17051

Conversation

lwj5 commented Nov 13, 2023 • edited Loading

PR checklist

icubbon Nov 13, 2023 • edited Loading

Choose a reason for hiding this comment

lwj5 Nov 16, 2023

Choose a reason for hiding this comment

icubbon Nov 16, 2023

Choose a reason for hiding this comment

lwj5 Nov 16, 2023

Choose a reason for hiding this comment

lwj5 commented Nov 16, 2023

icubbon Nov 16, 2023

Choose a reason for hiding this comment

lwj5 commented Nov 16, 2023 • edited Loading

icubbon commented Nov 17, 2023

icubbon left a comment

Choose a reason for hiding this comment

icubbon Nov 17, 2023

Choose a reason for hiding this comment

lwj5 Dec 5, 2023 • edited Loading

Choose a reason for hiding this comment

icubbon Nov 17, 2023

Choose a reason for hiding this comment

lwj5 Dec 5, 2023 • edited Loading

Choose a reason for hiding this comment

lwj5 commented Dec 5, 2023 • edited Loading

lwj5 commented Nov 13, 2023 •

edited

Loading

icubbon Nov 13, 2023 •

edited

Loading

lwj5 commented Nov 16, 2023 •

edited

Loading

lwj5 Dec 5, 2023 •

edited

Loading

lwj5 Dec 5, 2023 •

edited

Loading

lwj5 commented Dec 5, 2023 •

edited

Loading