Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[erlang] erlang-server generator fixes #20717

Merged
merged 3 commits into from
Feb 26, 2025

Conversation

kpy3
Copy link
Contributor

@kpy3 kpy3 commented Feb 24, 2025

Current erlang-server generates code with errors which will always crash on key authorisation. This PR fix them and also has minor performance improvements for map updates.

@tsloughter

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

@kpy3 kpy3 changed the title erlang-server generator fixes [erlang] erlang-server generator fixes Feb 24, 2025
@kpy3 kpy3 force-pushed the erlang-server-fixes branch from c9054c7 to bbb0504 Compare February 24, 2025 07:53
@wing328
Copy link
Member

wing328 commented Feb 25, 2025

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@kpy3 kpy3 force-pushed the erlang-server-fixes branch from bbb0504 to cdd0586 Compare February 25, 2025 11:10
@kpy3 kpy3 force-pushed the erlang-server-fixes branch from cdd0586 to 9d85a30 Compare February 25, 2025 11:22
@kpy3
Copy link
Contributor Author

kpy3 commented Feb 25, 2025

@wing328 thanks for pointing, fixed name and email, added back pgp signature. :)

@wing328
Copy link
Member

wing328 commented Feb 26, 2025

cc @NelsonVides who has made a lot of contributions to the erlang-server generator recently.

Copy link
Contributor

@NelsonVides NelsonVides left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely! Thank you for the contribution!

api_key_handler = Handler} = State) ->
case {{packageName}}_auth:authorize_api_key(Handler, OperationID, {{#isApiKey.isKeyInQuery}}qs_val, {{/isApiKey.isKeyInQuery}}{{^isApiKey.isKeyInQuery}}header, {{/isApiKey.isKeyInQuery}}{{#isApiKey}}"{{keyParamName}}", {{/isApiKey}}{{^isApiKey}}"authorization", {{/isApiKey}}Req0) of
api_key_callback = Handler} = State) ->
case {{packageName}}_auth:authorize_api_key(Handler, OperationID, {{#isApiKey.isKeyInQuery}}qs_val, {{/isApiKey.isKeyInQuery}}{{^isApiKey.isKeyInQuery}}header, {{/isApiKey.isKeyInQuery}}{{#isApiKey}}"{{keyParamName}}", {{/isApiKey}}{{^isApiKey}}<<"authorization">>, {{/isApiKey}}Req0) of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, so this needed to be a binary, that looks good 👌🏽

@@ -52,7 +52,7 @@ init(Req, {Operations, Module}) ->
State = #state{operation_id = OperationID,
accept_callback = fun Module:accept_callback/4,
provide_callback = fun Module:provide_callback/4,
api_key_handler = fun Module:authorize_api_key/2},
api_key_callback = fun Module:api_key_callback/2},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a moment I feared this would be a breaking change, but actually, this is really a bugfix, the callback was declared as api_key_callback/2 and dialyzer would complain, so the previous code would fail to bind to the right function and crash. Awesome find, thank you very much!

@wing328 wing328 merged commit 32573f7 into OpenAPITools:master Feb 26, 2025
20 checks passed
@wing328 wing328 added this to the 7.12.0 milestone Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants