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

[HttpBasicAuth] Use positive isBasicBasic tag instead of negative isBasicBearer #5095

Merged
merged 2 commits into from
Jan 24, 2020

Conversation

sebastien-rosset
Copy link
Contributor

@sebastien-rosset sebastien-rosset commented Jan 23, 2020

For HTTP basic auth, many mustache templates use a convention to negate the isBasicBearer tag, i.e. the case for HTTP basic auth is the negation of isBasicBearer. The problem is this only works when there are two possible HTTP auth, 1) basic auth and 2) bearer token. To support more http auth methods, we should stop using the negation of "isBasicBearer".

...
{{^isBasicBearer}}
   // do stuff for HTTP basic authentication
{{/isBasicBearer}}
{{#isBasicBearer}}
   // do stuff for bearer authentication
{{/isBasicBearer}}
....

I am proposing that instead, we change the templates as follows:

{{#isBasicBasic}}
   // do stuff for HTTP basic authentication
{{/isBasicBasic}}
{{#isBasicBearer}}
   // do stuff for bearer authentication
{{/isBasicBearer}}
....

I started making the change for Javascript. If that seems a reasonable change to reviewers, I can make the change everywhere.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@sebastien-rosset
Copy link
Contributor Author

This should fix #5025

@sebastien-rosset
Copy link
Contributor Author

See also #4993, #4959 and #4958, support for HTTP signature in core codegen, Python and golang.

@sebastien-rosset
Copy link
Contributor Author

@richardwhiuk , can you comment on this line: https://github.com/OpenAPITools/openapi-generator/blame/master/modules/openapi-generator/src/main/resources/rust-server/client-mod.mustache#L453

Logically, the test is "if OAuth2 and NOT BasicBearer". Can this be replaced with a positive test? The problem with not "BasicBearer" is that when new HTTP auth methods are added, this will still match the (NOT BasicBearer) clause, and that's probably not what you want.

Copy link
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

I'm ok with this change as it can support more cases in the future.

@wing328 wing328 merged commit 327ffc1 into OpenAPITools:master Jan 24, 2020
@wing328 wing328 added this to the 4.2.3 milestone Jan 24, 2020
@richardwhiuk
Copy link
Contributor

@sebastien-rosset I think that code is fine - it's just trying to eliminate a double match on Bearer being generated.

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